feat: add graphspace related docs#15
Conversation
|
@codecov-ai-reviewer review |
|
On it! We are reviewing the PR and will provide feedback shortly. |
|
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. Walkthrough将大量 REST 文档的示例路径与示意从 /graphs/{graph} 迁移为 /graphspaces/DEFAULT/graphs/{graph} 或 /graphspaces/{graphspace}/graphs/{graph}；新增 Graphspace CRUD 文档与图空间管理员（Manager）API；示例 id 由复合形式简化为纯用户名；补充分布式 PD 配置示例并同步中英文格式细节。 Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant Client as 客户端
participant REST as HugeGraph‑REST
participant Auth as Auth‑Service
note over REST,Auth `#E6F7FF`: 主要新增交互点：graphspace 路径与 Manager 授权
Client->>REST: 请求 /graphspaces/DEFAULT/graphs/{graph}/... 或 /graphspaces/{gs}/auth/...
alt Manager 相关操作
REST->>Auth: 校验/查询用户在图空间的角色
Auth-->>REST: 返回角色信息 (manager / none / other)
REST-->>Client: 返回授权结果或 403 拒绝
else 常规图空间/图操作
REST-->>Client: 返回数据或任务ID
Note over REST,Client: 任务链接格式 /graphspaces/DEFAULT/graphs/{graph}/tasks/{id}
end
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~40 minutes 需要额外关注：
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
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. Comment |
Summary of ChangesHello @Pengzna, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly enhances the HugeGraph documentation by introducing the concept and API for 'graph spaces'. It provides a dedicated guide for managing these multi-tenant environments and systematically updates all relevant existing API documentation to reflect the new Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![codecov-ai[bot]](https://avatars.githubusercontent.com/in/797565?s=60&v=4){kind=small}
| --- | ||
| title: "Graphspace API" | ||
| linkTitle: "Graphspace" | ||
| weight: 1 | ||
| --- | ||
|
|
||
| ### 2.0 Graphspace | ||
|
|
||
| 在 HugeGraph 中，多租户是通过图空间（graph space）来实现的，资源的分配和隔离可以通过图空间进行。 | ||
|
|
There was a problem hiding this comment.
The API documentation doesn't explain what happens when using the old API path without graphspace (e.g., /graphs/{graph}/...). Is there backward compatibility? Is there a default graphspace? This is critical information for users upgrading to this new API structure. Recommend adding a section explaining migration path and backward compatibility.
Severity: HIGH
🤖 Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.
Location: content/cn/docs/clients/restful-api/graphspace.md#L1-L10
Potential issue: The API documentation doesn't explain what happens when using the old
API path without graphspace (e.g., /graphs/{graph}/...). Is there backward
compatibility? Is there a default graphspace? This is critical information for users
upgrading to this new API structure. Recommend adding a section explaining migration
path and backward compatibility.
Did we get this right? 👍 / 👎 to inform future reviews.
| "name": "gs1", | ||
| "description": "1st graph space", | ||
| "cpu_limit": 1000, | ||
| "memory_limit": 1024, | ||
| "storage_limit": 1000, | ||
| "compute_cpu_limit": 0, | ||
| "compute_memory_limit": 0, | ||
| "oltp_namespace": "hugegraph-server", | ||
| "olap_namespace": "hugegraph-server", | ||
| "storage_namespace": "hugegraph-server", | ||
| "operator_image_path": "127.0.0.1/hugegraph-registry/hugegraph-computer-operator:3.1.1", | ||
| "internal_algorithm_image_url": "127.0.0.1/hugegraph-registry/hugegraph-computer-algorithm:3.1.1", | ||
| "max_graph_number": 100, | ||
| "max_role_number": 10, | ||
| "auth": false, |
There was a problem hiding this comment.
The request body example at line 50 shows various image path configurations (operator_image_path, internal_algorithm_image_url). However, there's no documentation of what these image paths should be or validation rules for them. For users unfamiliar with the system architecture, this is insufficient. Recommend adding guidance on obtaining valid image paths.
Severity: MEDIUM
🤖 Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.
Location: content/cn/docs/clients/restful-api/graphspace.md#L42-L56
Potential issue: The request body example at line 50 shows various image path
configurations (operator_image_path, internal_algorithm_image_url). However, there's no
documentation of what these image paths should be or validation rules for them. For
users unfamiliar with the system architecture, this is insufficient. Recommend adding
guidance on obtaining valid image paths.
Did we get this right? 👍 / 👎 to inform future reviews.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
| | cpu_limit | 是 | Int | | > 0 | CPU 核数 | | ||
| | memory_limit | 是 | Int | | > 0 | 内存大小，单位 GB | | ||
| | storage_limit | 是 | Int | | > 0 | 图空间的数据占据的磁盘空间上限 | | ||
| | compute_cpu_limit | 否 | Int | 0 | >= 0 | 针对图计算的额外资源配置，单位GB。当该字段不配置或者配置为0时，会由cpu_limit字段的值进行覆盖 | |
There was a problem hiding this comment.
compute_cpu_limit 的单位描述为 “单位GB”，这似乎是一个拼写错误。CPU 限制的单位通常是核数（cores）。此问题在第188行同样存在。请更正以避免混淆。
| { | ||
| "name": "gs1", | ||
| "description": "1st graph space", | ||
| "cpu_limit": 1000, | ||
| "memory_limit": 1024, | ||
| "storage_limit": 1000, | ||
| "compute_cpu_limit": 0, | ||
| "compute_memory_limit": 0, | ||
| "oltp_namespace": "hugegraph-server", | ||
| "olap_namespace": "hugegraph-server", | ||
| "storage_namespace": "hugegraph-server", | ||
| "operator_image_path": "127.0.0.1/hugegraph-registry/hugegraph-computer-operator:3.1.1", | ||
| "internal_algorithm_image_url": "127.0.0.1/hugegraph-registry/hugegraph-computer-algorithm:3.1.1", | ||
| "max_graph_number": 100, | ||
| "max_role_number": 10, | ||
| "cpu_used": 0, | ||
| "memory_used": 0, | ||
| "storage_used": 0, | ||
| "graph_number_used": 0, | ||
| "role_number_used": 0, | ||
| "auth": true | ||
| } |
There was a problem hiding this comment.
在创建图空间的示例中，请求体里的 "auth": false (第56行)，但响应体里却是 "auth": true (第90行)。这两个值应该保持一致以避免使用者困惑。如果创建时 auth 为 false，响应中也应为 false。
{
"name": "gs1",
"description": "1st graph space",
"cpu_limit": 1000,
"memory_limit": 1024,
"storage_limit": 1000,
"compute_cpu_limit": 0,
"compute_memory_limit": 0,
"oltp_namespace": "hugegraph-server",
"olap_namespace": "hugegraph-server",
"storage_namespace": "hugegraph-server",
"operator_image_path": "127.0.0.1/hugegraph-registry/hugegraph-computer-operator:3.1.1",
"internal_algorithm_image_url": "127.0.0.1/hugegraph-registry/hugegraph-computer-algorithm:3.1.1",
"max_graph_number": 100,
"max_role_number": 10,
"cpu_used": 0,
"memory_used": 0,
"storage_used": 0,
"graph_number_used": 0,
"role_number_used": 0,
"auth": false
}| ```json | ||
| { | ||
| "name": "gs1", | ||
| "description": "1st graph space", | ||
| "cpu_limit": 1000, | ||
| "memory_limit": 1024, | ||
| "storage_limit": 1000, | ||
| "oltp_namespace": "hugegraph-server", | ||
| "olap_namespace": "hugegraph-server", | ||
| "storage_namespace": "hugegraph-server", | ||
| "operator_image_path": "127.0.0.1/hugegraph-registry/hugegraph-computer-operator:3.1.1", | ||
| "internal_algorithm_image_url": "127.0.0.1/hugegraph-registry/hugegraph-computer-algorithm:3.1.1", | ||
| "compute_cpu_limit": 0, | ||
| "compute_memory_limit": 0, | ||
| "max_graph_number": 100, | ||
| "max_role_number": 10, | ||
| "cpu_used": 0, | ||
| "memory_used": 0, | ||
| "storage_used": 0, | ||
| "graph_number_used": 0, | ||
| "role_number_used": 0, | ||
| "auth": true | ||
| } |
There was a problem hiding this comment.
在更新图空间的示例中，响应体中的值没有反映请求中更新后的值。例如，请求中 "cpu_limit": 2000，但响应中仍然是 1000。为了文档的清晰和准确，响应体示例应该展示更新成功后的状态。
{
"name": "gs1",
"description": "1st graph space",
"cpu_limit": 2000,
"memory_limit": 40960,
"storage_limit": 2048,
"oltp_namespace": "hugegraph-server",
"olap_namespace": "hugegraph-server",
"storage_namespace": "hugegraph-server",
"operator_image_path": "127.0.0.1/hugegraph-registry/hugegraph-computer-operator:3.1.1",
"internal_algorithm_image_url": "127.0.0.1/hugegraph-registry/hugegraph-computer-algorithm:3.1.1",
"compute_cpu_limit": 0,
"compute_memory_limit": 0,
"max_graph_number": 1000,
"max_role_number": 100,
"cpu_used": 0,
"memory_used": 0,
"storage_used": 0,
"graph_number_used": 0,
"role_number_used": 0,
"auth": true
}![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (2)
content/cn/docs/clients/restful-api/graphs.md (1)
21-21: 添加代码块语言标识符根据 markdownlint-cli2 (MD040 规则)，第 21、53、89、114、161 行的代码块需要指定语言。这些 HTTP 端点示例应该添加语言标识符。
建议在这些代码块的 ``````` 后添加
bash或其他适当的语言标识符：- ``` + ```bash GET http://localhost:8080/graphspaces/gs1/graphs - ``` + ```这样可以提高代码块的可读性并符合 Markdown 的最佳实践。
Also applies to: 53-53, 89-89, 114-114, 161-161
content/cn/docs/clients/restful-api/graphspace.md (1)
15-15: 添加代码块的语言标识符Markdown linting 检查发现 5 个代码块缺少语言标识符。请为所有 HTTP 示例代码块添加语言标识：
- 第 15 行：改为
```bash或```shell- 第 98 行：改为
```bash或```shell- 第 129 行：改为
```bash或```shell- 第 200 行：改为
```bash或```shell- 第 268 行：改为
```bash或```shell例如，将第 15 行的：
POST http://localhost:8080/graphspaces
改为：
POST http://localhost:8080/graphspacesAlso applies to: 98-98, 129-129, 200-200, 268-268
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (17)
content/cn/docs/clients/restful-api/auth.md(27 hunks)content/cn/docs/clients/restful-api/cypher.md(3 hunks)content/cn/docs/clients/restful-api/edge.md(19 hunks)content/cn/docs/clients/restful-api/edgelabel.md(7 hunks)content/cn/docs/clients/restful-api/graphs.md(14 hunks)content/cn/docs/clients/restful-api/graphspace.md(1 hunks)content/cn/docs/clients/restful-api/gremlin.md(4 hunks)content/cn/docs/clients/restful-api/indexlabel.md(5 hunks)content/cn/docs/clients/restful-api/propertykey.md(6 hunks)content/cn/docs/clients/restful-api/rank.md(3 hunks)content/cn/docs/clients/restful-api/rebuild.md(4 hunks)content/cn/docs/clients/restful-api/schema.md(1 hunks)content/cn/docs/clients/restful-api/task.md(5 hunks)content/cn/docs/clients/restful-api/traverser.md(28 hunks)content/cn/docs/clients/restful-api/variable.md(4 hunks)content/cn/docs/clients/restful-api/vertex.md(13 hunks)content/cn/docs/clients/restful-api/vertexlabel.md(7 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
content/cn/docs/clients/restful-api/vertex.md
56-56: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
103-103: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
156-156: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
259-259: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
365-365: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
475-475: Multiple headings with the same content
(MD024, no-duplicate-heading)
477-477: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
602-602: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
640-640: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
644-644: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/cn/docs/clients/restful-api/graphs.md
21-21: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
53-53: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
89-89: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
114-114: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
161-161: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/cn/docs/clients/restful-api/auth.md
10-10: Blank line inside blockquote
(MD028, no-blanks-blockquote)
content/cn/docs/clients/restful-api/graphspace.md
15-15: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
98-98: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
129-129: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
200-200: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
268-268: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/cn/docs/clients/restful-api/rebuild.md
15-15: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
41-41: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
67-67: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (18)
content/cn/docs/clients/restful-api/schema.md (1)
9-9: LGTM!图空间前缀已正确添加，Schema API 端点从
/graphs/{graph_name}/schema更新到/graphspaces/gs1/graphs/{graph_name}/schema。重要提示的文案清晰准确。Also applies to: 16-18
content/cn/docs/clients/restful-api/variable.md (1)
9-9: LGTM!Variable API 的所有四个操作（创建/更新、列出全部、获取单个、删除）的端点均已正确更新到图空间命名空间下。前置说明一致。
Also applies to: 18-18, 48-48, 70-70, 92-92
content/cn/docs/clients/restful-api/auth.md (1)
57-57: LGTM!认证 API 的所有端点（用户、用户组、资源、角色关联、权限赋予等）均已一致地更新到
/graphspaces/gs1/graphs/hugegraph/...的命名空间下。请求和响应结构保持不变，符合最佳实践。Also applies to: 91-91, 115-115, 158-158, 193-193, 224-224, 275-275, 307-307, 331-331, 371-371, 406-406, 733-733, 758-758, 799-799, 834-834, 888-888, 921-921, 946-946, 987-987, 1023-1023
content/cn/docs/clients/restful-api/edgelabel.md (1)
9-9: LGTM!EdgeLabel API 的所有操作（创建、更新、获取列表、获取单个、删除）均已更新到图空间命名空间。第 316 行的异步任务查询端点引用也已正确更新。
Also applies to: 30-30, 139-139, 192-192, 254-254, 297-297, 316-316
content/cn/docs/clients/restful-api/rank.md (1)
9-9: LGTM!Rank API 的两个端点（Personal Rank 和 Neighbor Rank）均已正确更新到
/graphspaces/gs1/graphs/hugegraph/traversers/...的路径下。Also applies to: 157-157, 312-312
content/cn/docs/clients/restful-api/indexlabel.md (1)
9-9: LGTM!IndexLabel API 的所有操作（创建、获取列表、获取单个、删除）均已更新至图空间命名空间。第 178 行的异步任务查询参考也已正确更新。
Also applies to: 18-18, 64-64, 128-128, 159-159, 178-178
content/cn/docs/clients/restful-api/propertykey.md (1)
9-9: LGTM!PropertyKey API 的所有五个操作（创建、更新用户数据、获取列表、获取单个、删除）均已正确地更新到
/graphspaces/gs1/graphs/hugegraph/schema/propertykeys的路径下。Also applies to: 29-29, 78-78, 127-127, 206-206, 242-242
content/cn/docs/clients/restful-api/graphs.md (1)
9-9: LGTM！Graphs API 的所有端点操作（列表、信息查询、清空、克隆、创建、删除、配置、模式、读模式、快照、压缩等）均已正确更新至
/graphspaces/gs1/graphs/...命名空间。新增的路径参数说明文档（graphspace 和 graph）也清晰准确。Also applies to: 22-22, 54-54, 90-90, 115-115, 162-162, 231-231, 289-289, 313-313, 347-347, 373-373, 409-409, 435-435, 463-463
content/cn/docs/clients/restful-api/edge.md (2)
9-9: ✅ 重要提示格式正确且内容完整graphspace预先条件说明清晰，为用户提供了必要的背景信息。
66-67: ✅ API端点更新完整且一致所有API操作（创建、更新、删除、查询等）的端点都正确地更新为graphspace前缀格式，路径参数说明也正确添加。变更覆盖范围完整。
Also applies to: 83-83, 146-146, 214-214, 277-277, 379-379, 454-454, 491-491, 542-542, 591-591, 637-637, 653-653
content/cn/docs/clients/restful-api/gremlin.md (1)
9-9: ✅ 异步API端点更新正确Gremlin异步执行和任务查询端点都正确更新为graphspace前缀，与其他文件的变更模式一致。
Also applies to: 196-196, 233-233, 264-264
content/cn/docs/clients/restful-api/traverser.md (1)
9-9: ✅ 大范围端点更新覆盖完整Traverser API的所有操作端点（包括kout、kneighbor、路径查询、相似度计算等）都正确地更新为graphspace前缀。变更范围广泛且完整。
Also applies to: 217-217, 458-458, 536-536, 757-757, 801-801, 847-847, 907-907, 957-957, 1021-1021, 1106-1106, 1258-1258, 1486-1486, 1562-1562, 1661-1661, 1850-1850, 2014-2014, 2083-2083, 2253-2253, 2322-2322, 2409-2409, 2516-2516, 2595-2595, 2648-2648, 2832-2832, 2887-2887, 2944-2944
content/cn/docs/clients/restful-api/task.md (1)
9-9: ✅ 任务API端点更新完整所有任务管理操作（列出、查询、删除、取消）的端点都正确更新为graphspace前缀，与整体变更模式一致。
Also applies to: 21-21, 55-55, 87-87, 115-115
content/cn/docs/clients/restful-api/vertex.md (2)
9-9: ✅ 顶点API端点和参数说明更新完整添加了明确的路径参数说明，所有顶点操作端点都正确更新，curl命令示例也同步更新。变更范围覆盖了所有顶点操作。
Also applies to: 47-52, 57-57, 104-104, 157-157, 260-260, 366-366, 440-440, 478-478, 539-539, 603-603, 645-645, 661-661
247-247: ✅ curl命令示例正确更新批量操作的curl命令示例已正确更新为新的graphspace前缀格式，保证了用户可以直接使用文档中的示例。
Also applies to: 472-472
content/cn/docs/clients/restful-api/vertexlabel.md (1)
9-9: ✅ VertexLabel API端点和异步任务URL更新完整包括创建、更新、查询、删除等所有操作的端点，以及异步任务查询的URL，都正确更新为graphspace前缀格式。
Also applies to: 31-31, 130-130, 186-186, 251-251, 294-294, 313-313
content/cn/docs/clients/restful-api/cypher.md (1)
9-9: ✅ Cypher API端点参数化说明和示例更新完整GET和POST方法都添加了清晰的路径参数说明，使用示例也都更新为graphspace前缀格式。相比其他文档，这里更清晰地展示了参数化的端点格式。
Also applies to: 16-16, 21-24, 34-34, 71-71, 76-79, 92-92
content/cn/docs/clients/restful-api/rebuild.md (1)
9-9: ✅ Rebuild API端点和异步任务URL更新完整所有重建操作（IndexLabel、VertexLabel、EdgeLabel）的端点和对应的异步任务查询URL都正确更新为graphspace前缀格式。
Also applies to: 16-16, 42-42, 68-68, 35-35, 61-61, 87-87
…he#427) * chore: update release workflow and .gitignore entries Bumped default release version to 1.7.0 and updated default GPG user in the release workflow. Added installation step for subversion on Ubuntu. Appended WARP.md to .gitignore. * refactor: unify release validation script and add local path support Deleted validate-release-in-local.sh and enhanced validate-release.sh to support both SVN and local directory validation. Added color-coded output, improved argument handling, and included Java version checks for better usability and error reporting. * refactor: revamp release validation script with enhanced checks V2 Major rewrite of validate-release.sh for Apache HugeGraph, adding modular structure, improved logging, error/warning collection, colorized output, and comprehensive validation steps for source and binary packages. New features include dependency checks, GPG key management, license compliance, file size and binary checks, version consistency, and automated server/toolchain testing. Usage instructions and help output are expanded for clarity. * refactor: enhance release validation for multi-arch and license checks V3 Updated CI workflow to support additional OS and architectures (arm64, macOS 14). Improved documentation and script usage instructions. The license header check now covers more file types and excludes generated/vendor files. Maven build commands in docs and scripts now use '-DskipTests' and '-Dcheckstyle.skip=true' for consistency. Added a detailed README for the release validation script. * refactor: improve validation script error context and reporting V4 Adds contextual error and warning reporting with step and package information, enhances license category and header checks, improves version consistency logic, and refines summary output with execution time and clearer formatting. These changes make validation results more actionable and easier to interpret, especially for multi-package and multi-step validations. * fix: add JSON to CATEGORY_X license validation The JSON license was added to the CATEGORY_X regex in the binary package validation step to ensure packages with this license are properly flagged during release validation. * Update .github/workflows/validate-release.yml * Update .github/workflows/validate-release.yml --------- Co-authored-by: Peng Junzhi <78788603+Pengzna@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (12)
content/cn/docs/clients/restful-api/variable.md (1)
15-17: 添加代码块语言标识。所有4个fenced code blocks缺少语言标识符。建议在三个反引号后添加语言标识符（如"bash"或"http"）以改进可读性。
示例：
-``` +```http PUT http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/variables/name -``` +```Also applies to: 45-47, 67-69, 89-91
content/cn/docs/clients/restful-api/task.md (1)
18-20: 添加代码块语言标识。所有4个fenced code blocks缺少语言标识符。建议添加语言标识（如"http"）。
Also applies to: 52-54, 84-86, 112-114
content/cn/docs/clients/restful-api/indexlabel.md (1)
15-17: 添加代码块语言标识。4个fenced code blocks缺少语言标识符，建议添加"http"作为标识。
Also applies to: 61-63, 125-127, 156-158
content/cn/docs/clients/restful-api/vertexlabel.md (1)
27-29: 添加代码块语言标识。5个fenced code blocks缺少语言标识符，建议添加"http"。
Also applies to: 126-128, 182-184, 247-249, 290-292
content/cn/docs/clients/restful-api/rebuild.md (1)
13-15: 添加代码块语言标识。3个fenced code blocks缺少语言标识符，建议添加"http"。
Also applies to: 39-41, 65-67
content/cn/docs/clients/restful-api/edge.md (1)
80-82: 添加代码块语言标识。第一个fenced code block缺少语言标识符，建议添加"http"。
content/cn/docs/clients/restful-api/traverser.md (2)
214-216: 添加缺失的代码块语言标识。此文件中有约30个fenced code blocks缺少语言标识符。建议为所有代码块添加"http"作为语言标识，以改进文档的可读性和代码高亮效果。
Also applies to: 288-290, 455-457, 533-535, 754-756, 798-800, 844-846, 904-906, 954-956, 1018-1020, 1103-1105, 1255-1257, 1483-1485, 1559-1561, 1658-1660, 1847-1849, 2011-2013, 2250-2252, 2319-2321, 2406-2408, 2513-2515, 2592-2594, 2645-2647, 2829-2831, 2941-2943
7-51: 格式化改进。traverser API概述部分的文本调整和列表格式已改进，使文档结构更清晰。但markdownlint工具报告了多个列表缩进不一致的问题。虽然这些问题不会影响文档的实际呈现，但建议审查这些警告以确保markdown格式的一致性。
注意：许多缩进警告可能是由于使用硬制表符（hard tabs）而不是空格造成的。
content/cn/docs/clients/restful-api/rank.md (1)
144-146: 修复 Markdown 列表缩进不一致静态分析工具检测到列表项缩进不符合规范（MD007）：
- 第 144-146 行：预期缩进 2，实际缩进 4
- 第 302-303 行：列表项缩进不一致
建议统一调整列表缩进以符合 Markdown 规范。
Also applies to: 302-303
content/cn/docs/clients/restful-api/vertex.md (1)
55-55: 代码块需指定编程语言根据 markdownlint 规范（MD040），以下代码块应指定语言标识符：
- 第 54、101、154、257、363、437、475、600、642、658 行
建议在代码块开始处添加语言标识，例如
```bash、```json等。Also applies to: 102-102, 155-155, 257-258, 363-364, 437-438, 475-476, 600-601, 642-643, 658-659
content/cn/docs/clients/restful-api/gremlin.md (2)
135-135: 修复块引用内的空白行根据 markdownlint（MD028）规范，第 135 行块引用内的空白行应删除。块引用内容应保持连续。
193-193: 代码块应指定语言标识符根据 markdownlint（MD040）规范，第 193 行的代码块应指定语言，例如
```bash或相应的语言标识。
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (18)
content/cn/docs/clients/restful-api/auth.md(36 hunks)content/cn/docs/clients/restful-api/cypher.md(2 hunks)content/cn/docs/clients/restful-api/edge.md(18 hunks)content/cn/docs/clients/restful-api/edgelabel.md(7 hunks)content/cn/docs/clients/restful-api/graphs.md(14 hunks)content/cn/docs/clients/restful-api/graphspace.md(1 hunks)content/cn/docs/clients/restful-api/gremlin.md(7 hunks)content/cn/docs/clients/restful-api/indexlabel.md(5 hunks)content/cn/docs/clients/restful-api/propertykey.md(5 hunks)content/cn/docs/clients/restful-api/rank.md(4 hunks)content/cn/docs/clients/restful-api/rebuild.md(4 hunks)content/cn/docs/clients/restful-api/schema.md(2 hunks)content/cn/docs/clients/restful-api/task.md(4 hunks)content/cn/docs/clients/restful-api/traverser.md(40 hunks)content/cn/docs/clients/restful-api/variable.md(4 hunks)content/cn/docs/clients/restful-api/vertex.md(14 hunks)content/cn/docs/clients/restful-api/vertexlabel.md(7 hunks)content/cn/docs/quickstart/hugegraph/hugegraph-server.md(2 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
- content/cn/docs/clients/restful-api/schema.md
- content/cn/docs/clients/restful-api/cypher.md
- content/cn/docs/clients/restful-api/edgelabel.md
🧰 Additional context used
🪛 LanguageTool
content/cn/docs/clients/restful-api/rank.md
[uncategorized] ~127-~127: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：共同"地"打分
Context: ...如果决定向外游走，那么会选取某一个类型的出边，例如 rating 来查找共同的打分人： 1. 那就从当前节点的邻居节点中按照均匀分布随机选择一个，并且按...
(wb4)
content/cn/docs/clients/restful-api/traverser.md
[uncategorized] ~13-~13: 您的意思是“"不"可”？
Context: ...rser API 包括： - K-out API，根据起始顶点，查找恰好 N 步可达的邻居，分为基础版和高级版： - 基础版使用 GET 方法，根据起始...
(BU)
[uncategorized] ~14-~14: 您的意思是“"不"可”？
Context: ...版和高级版： - 基础版使用 GET 方法，根据起始顶点，查找恰好 N 步可达的邻居 - 高级版使用 POST 方法，根据起始顶点，查找恰好 N ...
(BU)
[uncategorized] ~15-~15: 您的意思是“"不"可”？
Context: ...可达的邻居 - 高级版使用 POST 方法，根据起始顶点，查找恰好 N 步可达的邻居，与基础版的不同在于： - 支持只统计邻居数量 ...
(BU)
[uncategorized] ~19-~19: 您的意思是“"不"以内”？
Context: ...回到达邻居的最短路径 - K-neighbor API，根据起始顶点，查找 N 步以内可达的所有邻居，分为基础版和高级版： - 基础版使用 GET 方法，...
(BU)
[uncategorized] ~20-~20: 您的意思是“"不"以内”？
Context: ...基础版和高级版： - 基础版使用 GET 方法，根据起始顶点，查找 N 步以内可达的所有邻居 - 高级版使用 POST 方法，根据起始顶点，查找 ...
(BU)
[uncategorized] ~21-~21: 您的意思是“"不"以内”？
Context: ...可达的所有邻居 - 高级版使用 POST 方法，根据起始顶点，查找 N 步以内可达的所有邻居，与基础版的不同在于： - 支持只统计邻居数量...
(BU)
[uncategorized] ~197-~197: 您的意思是“"不"可”？
Context: ...、方向、边的类型（可选）和深度 depth，查找从起始顶点出发恰好 depth 步可达的顶点 ###### Params - source：起始顶点 id，必...
(BU)
[uncategorized] ~237-~237: 您的意思是“"不"关系”？
Context: ... ] } ``` ##### 3.2.1.3 适用场景 查找恰好 N 步关系可达的顶点。两个例子： - 家族关系中，查找一个人的所有孙子，person...
(BU)
[uncategorized] ~246-~246: 您的意思是“"不"可”？
Context: ...方向、边类型和过滤属性）和深度 depth，查找从起始顶点出发恰好 depth 步可达的顶点。 > 与 K-out 基础版的不同在于： > - 支持只统计邻居数...
(BU)
[uncategorized] ~438-~438: 您的意思是“"不"之内”？
Context: ...点、方向、边的类型（可选）和深度 depth，查找包括起始顶点在内、depth 步之内可达的所有顶点 > 相当于：起始顶点、K-out(1)、K-out(2)、...
(BU)
[uncategorized] ~482-~482: 您的意思是“"不"以内”？
Context: ..." ] } ``` ##### 3.2.3.3 适用场景 查找 N 步以内可达的所有顶点，例如： - 家族关系中，查找一个人五服以内所有子孙，per...
(BU)
[uncategorized] ~492-~492: 您的意思是“"不"内”？
Context: ...包括方向、边类型和过滤属性）和深度 depth，查找从起始顶点出发 depth 步内可达的所有顶点。 > 与 K-neighbor 基础版的不同在于： > - ...
(BU)
[uncategorized] ~1649-~1649: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：重"地"降
Context: ...- INCR 表示按照路径权重的升序排序 - DECR 表示按照路径权重的降序排序 - capacity：遍历过程中最大的访问的顶点数目，选填项，默认为 ...
(wb4)
🪛 markdownlint-cli2 (0.18.1)
content/cn/docs/clients/restful-api/edge.md
588-588: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/cn/docs/clients/restful-api/rank.md
144-144: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
145-145: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
146-146: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
155-155: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
302-302: Inconsistent indentation for list items at the same level
Expected: 1; Actual: 4
(MD005, list-indent)
302-302: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
303-303: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
303-303: Hard tabs
Column: 1
(MD010, no-hard-tabs)
310-310: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/cn/docs/clients/restful-api/gremlin.md
135-135: Blank line inside blockquote
(MD028, no-blanks-blockquote)
193-193: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/cn/docs/clients/restful-api/indexlabel.md
15-15: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
61-61: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
125-125: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
156-156: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/cn/docs/clients/restful-api/vertex.md
54-54: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
101-101: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
154-154: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
257-257: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
363-363: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
433-433: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
437-437: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
465-465: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
473-473: Multiple headings with the same content
(MD024, no-duplicate-heading)
475-475: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
532-532: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
534-534: Multiple headings with the same content
(MD024, no-duplicate-heading)
536-536: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
600-600: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
638-638: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
642-642: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
652-652: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
656-656: Multiple headings with the same content
(MD024, no-duplicate-heading)
658-658: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/cn/docs/clients/restful-api/vertexlabel.md
27-27: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
182-182: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
247-247: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
290-290: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/cn/docs/clients/restful-api/traverser.md
14-14: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
15-15: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
16-16: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
17-17: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
18-18: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
20-20: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
21-21: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
22-22: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
23-23: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
24-24: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
27-27: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
28-28: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
35-35: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
36-36: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
45-45: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
46-46: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
46-46: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
46-46: Hard tabs
Column: 1
(MD010, no-hard-tabs)
47-47: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
47-47: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
47-47: Hard tabs
Column: 1
(MD010, no-hard-tabs)
49-49: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
50-50: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
50-50: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
50-50: Hard tabs
Column: 1
(MD010, no-hard-tabs)
51-51: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
51-51: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
51-51: Hard tabs
Column: 1
(MD010, no-hard-tabs)
214-214: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
257-257: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
258-258: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
259-259: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
260-260: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
261-261: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
262-262: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
263-263: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
264-264: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
265-265: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
271-271: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
272-272: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
273-273: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
274-274: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
276-276: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
277-277: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
278-278: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
279-279: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
288-288: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
455-455: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
503-503: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
504-504: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
505-505: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
506-506: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
507-507: Unordered list indentation
Expected: 6; Actual: 12
(MD007, ul-indent)
508-508: Unordered list indentation
Expected: 6; Actual: 12
(MD007, ul-indent)
509-509: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
510-510: Unordered list indentation
Expected: 6; Actual: 12
(MD007, ul-indent)
511-511: Unordered list indentation
Expected: 6; Actual: 12
(MD007, ul-indent)
512-512: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
513-513: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
518-518: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
519-519: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
520-520: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
521-521: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
523-523: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
524-524: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
525-525: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
526-526: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
533-533: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
754-754: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
798-798: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
832-832: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
833-833: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
833-833: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
833-833: Hard tabs
Column: 1
(MD010, no-hard-tabs)
834-834: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
834-834: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
834-834: Hard tabs
Column: 1
(MD010, no-hard-tabs)
835-835: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
836-836: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
844-844: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
904-904: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
954-954: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1018-1018: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1103-1103: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1236-1236: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1237-1237: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1238-1238: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
1238-1238: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1239-1239: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
1239-1239: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1242-1242: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1243-1243: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
1243-1243: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
1243-1243: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1244-1244: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
1244-1244: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
1244-1244: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1245-1245: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1246-1246: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1255-1255: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1483-1483: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1531-1531: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1532-1532: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1533-1533: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
1533-1533: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1534-1534: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
1534-1534: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1537-1537: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1538-1538: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1539-1539: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
1539-1539: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1540-1540: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
1540-1540: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1543-1543: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1544-1544: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
1544-1544: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
1544-1544: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1545-1545: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
1545-1545: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
1545-1545: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1546-1546: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1547-1547: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1559-1559: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1633-1633: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1634-1634: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1635-1635: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
1635-1635: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1636-1636: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
1636-1636: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1639-1639: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1640-1640: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
1640-1640: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
1640-1640: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1641-1641: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
1641-1641: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
1641-1641: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1642-1642: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1643-1643: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1644-1644: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1645-1645: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1647-1647: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1648-1648: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1649-1649: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1658-1658: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1820-1820: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1821-1821: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1822-1822: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
1822-1822: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1823-1823: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
1823-1823: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1826-1826: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1827-1827: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1828-1828: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
1828-1828: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1829-1829: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
1829-1829: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1832-1832: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1833-1833: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
1833-1833: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
1833-1833: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1834-1834: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
1834-1834: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
1834-1834: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1835-1835: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1836-1836: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1837-1837: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1847-1847: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
2011-2011: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
2054-2054: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
2055-2055: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
2056-2056: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
2056-2056: Hard tabs
Column: 1
(MD010, no-hard-tabs)
2057-2057: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
2057-2057: Hard tabs
Column: 1
(MD010, no-hard-tabs)
2061-2061: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
2062-2062: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
2063-2063: Inconsistent indentation for list items at the same level
Expected: 8; Actual: 2
(MD005, list-indent)
2063-2063: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
2063-2063: Hard tabs
Column: 1
(MD010, no-hard-tabs)
2064-2064: Inconsistent indentation for list items at the same level
Expected: 8; Actual: 2
(MD005, list-indent)
2064-2064: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
2064-2064: Hard tabs
Column: 1
(MD010, no-hard-tabs)
2065-2065: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
2066-2066: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
2071-2071: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
2072-2072: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
2073-2073: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
2074-2074: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
2080-2080: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
2250-2250: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
2319-2319: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
2380-2380: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
2381-2381: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
2382-2382: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
2382-2382: Hard tabs
Column: 1
(MD010, no-hard-tabs)
2383-2383: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
2383-2383: Hard tabs
Column: 1
(MD010, no-hard-tabs)
2399-2399: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
2400-2400: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
2406-2406: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
2513-2513: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
2645-2645: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
2829-2829: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
2941-2941: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/cn/docs/clients/restful-api/rebuild.md
13-13: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
39-39: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
65-65: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/cn/docs/clients/restful-api/graphspace.md
13-13: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
39-39: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
65-65: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/cn/docs/clients/restful-api/variable.md
15-15: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (10)
content/cn/docs/quickstart/hugegraph/hugegraph-server.md (1)
190-207: 改进分布式存储配置步骤结构。将原本的无序配置说明改进为显式的"Step 1"和"Step 2"，使配置流程更清晰。这个改进有助于用户按顺序完成配置。
content/cn/docs/clients/restful-api/propertykey.md (1)
27-27: API 路径迁移一致性良好所有 PropertyKey 端点的基础 URL 路径已正确迁移到
/graphspaces/DEFAULT/graphs/hugegraph/...结构，包括创建、更新、列表、获取和删除操作。路径参数文档也已相应添加。迁移完整且一致。Also applies to: 76-76, 125-125, 204-204, 240-240
content/cn/docs/clients/restful-api/graphs.md (1)
9-21: 图空间路径参数文档完整新增Graphs API 文档已系统地添加了路径参数说明（graphspace、graph），并将所有端点 URL 迁移到
/graphspaces/DEFAULT/graphs结构。参数文档化清晰，覆盖所有核心操作。Also applies to: 42-78
content/cn/docs/clients/restful-api/rank.md (1)
156-156: 端点 URL 已正确迁移至图空间前缀PersonalRank 和 NeighborRank 的端点 URL 均已更新为
/graphspaces/DEFAULT/graphs/hugegraph/traversers/...结构。Also applies to: 311-311
content/cn/docs/clients/restful-api/vertex.md (1)
45-51: 顶点 API 路径参数文档系统化完善Vertex API 已一致地为所有端点添加了详细的路径参数说明（graphspace、graph、id），并将所有 URL 迁移到
/graphspaces/DEFAULT/graphs/hugegraph/graph/vertices结构。参数文档清晰且覆盖全面。Also applies to: 92-98, 144-151, 248-254, 353-360, 404-408
content/cn/docs/clients/restful-api/graphspace.md (1)
1043-1200: Manager API 新增部分结构完整新增的图空间管理员（Manager）API（第 10.7 节）文档结构完整，包括五个操作：检查角色、列表、授权、取消授权、查询用户角色。前置提示清晰指出需先创建 gs1 图空间，示例 URL 使用一致。
content/cn/docs/clients/restful-api/auth.md (3)
55-55: 认证 API 路径已完整迁移至图空间前缀所有认证相关端点的 URL 已一致地从
/graphs/hugegraph/auth/...迁移到/graphspaces/DEFAULT/auth/...结构，涵盖用户、用户组、资源、关联角色、赋权等所有五类 API。Also applies to: 89-89, 113-113, 156-156, 191-191, 222-222, 273-273, 305-305, 329-329, 369-369, 404-404, 467-467, 507-507, 532-532, 586-586, 645-645, 700-700, 731-731, 756-756, 797-797, 832-832, 886-886, 919-919, 944-944, 985-985, 1021-1021
74-74: 用户/组标识字段格式统一简化API 响应中的
id和user字段已从复合格式（如 "-63:boss"）简化为直接的用户名格式（如 "boss"），该格式调整在用户、关联角色等端点响应中保持一致。Also applies to: 141-141, 175-175, 210-210, 716-717, 781-782, 815-816, 848-849
1044-1200: 图空间管理员 API 新增结构完整新增的 Manager API（第 10.7 节）为图空间管理员管理提供了完整的五个操作端点，包括角色检查、列表查询、权限授权、权限取消、角色查询。文档清晰指出前置条件（需创建 gs1 图空间），示例 URL 和请求体格式一致规范。
content/cn/docs/clients/restful-api/gremlin.md (1)
194-194: Gremlin 异步执行端点路径已更新至图空间前缀异步 Gremlin 执行端点（第 194 行）已更新为
/graphspaces/DEFAULT/graphs/hugegraph/jobs/gremlin，对应的任务查询端点（第 231、262 行）也更新为/graphspaces/DEFAULT/graphs/hugegraph/tasks/{id}结构，保持一致。Also applies to: 231-231, 262-262
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (5)
content/en/docs/clients/restful-api/_index.md (1)
7-8: 澄清版本兼容性说明中的 API 路径迁移指引。第 8 行的说明表述不够清晰。"api path needs to be removed from /graphspaces/{graphspace}" 这个表述容易产生歧义——用户可能不清楚在版本 < 1.7.0 时应该使用什么替代的 API 路径格式。
建议明确说明：对于版本 < 1.7.0，应使用旧的
/graphs/...路径格式，或者更详细地说明具体的迁移步骤。示例修改：
-Version 1.7.0 introduced the graphspace feature. If version <1.7.0, the api path needs to be removed from /graphspaces/{graphspace}. +Version 1.7.0 introduced the graphspace feature. For versions <1.7.0, use the legacy `/graphs/...` path format instead of `/graphspaces/{graphspace}`.content/en/docs/clients/restful-api/task.md (1)
11-15: 建议补充路径参数文档说明。当前 "Params" 部分仅记录了查询参数（status、limit），未说明新增的路径参数含义。建议在 "Params" 或新增的参数说明中阐释：
graphspaces: 图空间标识符（示例中为 DEFAULT）graphs: 图数据库标识符（示例中为 hugegraph）这将帮助 API 使用者更清楚地理解和使用这些端点。
content/en/docs/clients/restful-api/variable.md (1)
7-97: 建议添加图空间参数说明（可选改进）。为了帮助用户理解新的路由结构，建议在文件开头或各个端点前添加简要说明，解释
graphspaces/DEFAULT的含义（例如：DEFAULT 是默认图空间名称，用户可根据实际需求替换为自己的图空间名称）。这将提升文档的易用性，特别是对初次接触图空间概念的用户。content/cn/docs/clients/restful-api/_index.md (1)
7-9: 改进第9行版本说明的表述清晰度。第9行的表述可以更加清晰明确。建议调整为：
- 将"若版本<1.7.0"改为"对于 1.7.0 之前的版本"
- 将"api 路径需要去除 /graphspaces/{graphspace}"改为"API 路径应移除 /graphspaces/{graphspace} 部分"或"API 端点路径不应包含 /graphspaces/{graphspace}"
这样可以提高文档的可读性，帮助用户更快速地理解版本兼容性信息。
建议的修改：
-1.7.0 版本引入了图空间功能，若版本<1.7.0，api 路径需要去除 /graphspaces/{graphspace} +1.7.0 版本引入了图空间功能。对于 1.7.0 之前的版本，API 端点路径应移除 /graphspaces/{graphspace} 部分。content/cn/docs/quickstart/hugegraph/hugegraph-server.md (1)
209-249: 多节点配置示例完整，建议明确标注配置差异和依赖关系。多节点配置示例清晰展示了主从节点的不同配置，但建议补充以下内容以增强可读性：
- 在节点 1 和节点 2 的配置块前添加显式说明，指出
usePD=true是分布式存储部署时所有节点的必需配置- 在
gremlin-server.yaml端口配置示例中，说明这些端口号（8181、8182）如何与rest-server.properties中的gremlinserver.url对应- 补充说明当节点数 > 2 时如何类似地扩展配置
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (20)
content/cn/docs/clients/restful-api/_index.md(1 hunks)content/cn/docs/clients/restful-api/graphs.md(14 hunks)content/cn/docs/quickstart/hugegraph/hugegraph-server.md(4 hunks)content/en/docs/clients/restful-api/_index.md(1 hunks)content/en/docs/clients/restful-api/auth.md(36 hunks)content/en/docs/clients/restful-api/edge.md(11 hunks)content/en/docs/clients/restful-api/edgelabel.md(6 hunks)content/en/docs/clients/restful-api/graphs.md(14 hunks)content/en/docs/clients/restful-api/gremlin.md(3 hunks)content/en/docs/clients/restful-api/indexlabel.md(5 hunks)content/en/docs/clients/restful-api/propertykey.md(5 hunks)content/en/docs/clients/restful-api/rank.md(2 hunks)content/en/docs/clients/restful-api/rebuild.md(4 hunks)content/en/docs/clients/restful-api/schema.md(1 hunks)content/en/docs/clients/restful-api/task.md(4 hunks)content/en/docs/clients/restful-api/traverser.md(7 hunks)content/en/docs/clients/restful-api/variable.md(4 hunks)content/en/docs/clients/restful-api/vertex.md(11 hunks)content/en/docs/clients/restful-api/vertexlabel.md(6 hunks)content/en/docs/quickstart/hugegraph/hugegraph-server.md(6 hunks)
✅ Files skipped from review due to trivial changes (5)
- content/en/docs/clients/restful-api/schema.md
- content/en/docs/clients/restful-api/propertykey.md
- content/en/docs/clients/restful-api/vertexlabel.md
- content/en/docs/clients/restful-api/indexlabel.md
- content/en/docs/clients/restful-api/edge.md
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
content/en/docs/clients/restful-api/rebuild.md
38-38: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
64-64: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/en/docs/quickstart/hugegraph/hugegraph-server.md
49-49: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
49-49: Hard tabs
Column: 1
(MD010, no-hard-tabs)
content/cn/docs/clients/restful-api/graphs.md
19-19: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
51-51: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
87-87: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
112-112: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
161-161: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/en/docs/clients/restful-api/auth.md
919-919: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
945-945: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
984-984: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1016-1016: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1040-1040: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (30)
content/en/docs/clients/restful-api/edgelabel.md (6)
27-27: API 端点路径已一致性迁移至 GraphSpace 作用域。创建 EdgeLabel 的 POST 端点已正确更新至 GraphSpace 作用域路径
/graphspaces/DEFAULT/graphs/hugegraph/schema/edgelabels。变更符合 PR 目标的路径统一迁移需求。
136-136: 修改 EdgeLabel 的 PUT 端点路径一致性良好。添加属性/用户数据操作的 PUT 端点已正确更新，保持与其他操作一致的 GraphSpace 作用域路径格式。
189-189: 获取所有 EdgeLabel 的 GET 端点路径更新正确。已按照统一标准迁移至 GraphSpace 作用域路径。
251-251: 按名称查询 EdgeLabel 的 GET 端点路径更新一致。端点路径与其他操作保持一致的 GraphSpace 作用域格式。
294-294: 删除 EdgeLabel 的 DELETE 端点路径已正确迁移。端点路径遵循统一的 GraphSpace 作用域标准。
313-313: 异步任务查询 URL 与 DELETE 操作保持一致性。Note 中的异步任务查询端点也正确更新至 GraphSpace 作用域路径，确保文档示例的完整性和可执行性。
content/en/docs/clients/restful-api/task.md (1)
19-19: 路径参数更新正确且一致。所有四个 Task API 端点的 URL 已正确更新，从
/graphs/hugegraph/迁移到/graphspaces/DEFAULT/graphs/hugegraph/，与 PR 目标一致。Also applies to: 53-53, 85-85, 113-113
content/en/docs/clients/restful-api/variable.md (1)
16-16: 端点路径迁移至图空间作用域，变更一致性良好。所有四个 Variable API 端点均已正确迁移至
/graphspaces/DEFAULT/graphs/hugegraph/variables的新路径模式：
- PUT 端点（创建/更新）：第 16 行
- GET 端点（列出所有）：第 46 行
- GET 端点（获取特定键）：第 68 行
- DELETE 端点（删除特定键）：第 90 行
请求体和响应体保持不变，变更逻辑正确。
Also applies to: 46-46, 68-68, 90-90
content/en/docs/clients/restful-api/gremlin.md (4)
186-192: 端点路径正确更新为图空间作用域格式。异步Gremlin操作的POST端点已正确迁移至新的
/graphspaces/DEFAULT/graphs/hugegraph/jobs/gremlin路径，与PR目标一致。路径结构清晰且遵循文档中定义的图空间模式。
225-228: 异步任务查询文档已正确更新。第一个异步操作的任务查询说明已更新为新路径格式
/graphspaces/DEFAULT/graphs/hugegraph/tasks/1，并正确引用对应的task_id。与响应体中的task_id相匹配。
256-259: 第二个异步操作的任务查询文档也已正确更新。边查询操作的任务状态查询说明同样使用新的
/graphspaces/DEFAULT/graphs/hugegraph/tasks/2路径格式，与响应体中的task_id一致。
1-73: 请验证同步端点是否需要更新。同步Gremlin操作的端点（第23行GET请求和第72行POST请求）仍使用
/gremlin路径，未包含/graphspaces/DEFAULT/前缀。请确认这是符合PR设计的有意之举，还是需要一致性更新。如果文档的其他部分已更新同步操作的端点，则应保持一致性。content/en/docs/clients/restful-api/rebuild.md (4)
30-32: 验证任务查询 URL 的一致性。注释中的任务查询 URL 已正确更新为
/graphspaces/DEFAULT/graphs/hugegraph/tasks/${task_id}的格式，与主 API 端点的路径一致。此项更改准确无误。
56-58: 验证任务查询 URL 的一致性。注释中的任务查询 URL 已正确更新为
/graphspaces/DEFAULT/graphs/hugegraph/tasks/${task_id}的格式，与主 API 端点的路径一致。此项更改准确无误。
82-84: 验证任务查询 URL 的一致性。注释中的任务查询 URL 已正确更新为
/graphspaces/DEFAULT/graphs/hugegraph/tasks/${task_id}的格式，与主 API 端点的路径一致。此项更改准确无误。
1-84: 验证图空间路径迁移的完整性。本文档中所有重建操作（IndexLabel、VertexLabel、EdgeLabel）的端点均已从
/graphs/hugegraph迁移至/graphspaces/DEFAULT/graphs/hugegraph，遵循 PR 目标中的路径模式。建议确认整个项目文档库中的其他 API 端点也遵循相同的迁移模式，以保持文档的一致性。content/cn/docs/quickstart/hugegraph/hugegraph-server.md (3)
20-24: Java 版本指导信息清晰完整。对 Java 版本要求的表述进行了优化，明确指出 Java 11 作为推荐版本，同时保留了 1.5.0 前版本的 Java 8 基本兼容性说明，并新增了 1.7.0 不再支持的提醒。表述清晰且层次分明。
190-207: 分布式存储配置步骤结构清晰，建议验证配置项的完整性。新增的分布式存储配置说明引入了分步骤的结构（1. 和 2.），使用户更易理解配置流程。建议确认以下几点：
- PD 地址配置中的 RPC 端口说明（8686-8688）是否为当前推荐配置
usePD=true配置是否为使用分布式存储的必需且充分条件- 是否需要在配置说明中补充关于
serializer=binary和task.scheduler_type=distributed这两个关键配置项对分布式存储的影响说明
251-285: 分布式存储启动、验证及停止流程完整。初始化、启动、验证、停止的完整流程已清晰展现，且特别注意到了启动和停止顺序的重要性。建议验证：
- 验证分步骤中是否涵盖了所有必要的初始化和配置操作（目前文档从 PD/Store 启动后开始，这是合理的假设）
- 确认验证命令
curl http://localhost:8081/graphs中的端口 8081 与前文"节点 1"配置中的restserver.url=http://127.0.0.1:8081一致content/en/docs/clients/restful-api/traverser.md (1)
2417-2417: ✓ 端点路径迁移一致 — 遍历器API的所有示例端点都正确地从/graphs/{graph}/traversers/...迁移到了/graphspaces/DEFAULT/graphs/{graph}/traversers/...格式，与PR目标相符。Also applies to: 2524-2524, 2603-2603, 2656-2656, 2840-2840, 2895-2895, 2952-2952
content/en/docs/clients/restful-api/rank.md (1)
165-165: ✓ 排名API端点正确转换 — Personal Rank和Neighbor Rank两个主要端点都已正确迁移到/graphspaces/DEFAULT/graphs/hugegraph/traversers/格式。Also applies to: 321-321
content/en/docs/clients/restful-api/vertex.md (1)
48-48: ✓ 顶点API端点全部迁移 — 所有顶点操作端点(创建、批量操作、更新、删除、查询等)都已一致地迁移到/graphspaces/DEFAULT/graphs/hugegraph/graph/...格式，包括curl命令示例。Also applies to: 88-88, 133-133, 223-223, 229-229, 327-327, 394-394, 426-426, 432-432, 493-493, 549-549, 583-583, 599-599
content/en/docs/clients/restful-api/graphs.md (2)
39-39: ✓ 图操作API端点完整迁移 — Graphs API的所有操作(列表、详情、清空、克隆、创建、删除、配置、模式、快照、压缩等)都正确迁移到/graphspaces/DEFAULT/graphs/格式。Also applies to: 72-72, 92-92, 134-134, 186-186, 204-204, 263-263, 287-287, 321-321, 347-347, 383-383, 409-409, 437-437
99-107: ✓ JSON配置体和版本兼容性改进 — 文档中添加了JSON配置体示例，并包含了对HugeGraph 1.5.0及更早版本的向后兼容性说明(需继续使用text/plain格式)，这是有益的改进。Also applies to: 121-127, 141-149, 170-177
content/cn/docs/clients/restful-api/graphs.md (1)
9-47: ✓ 中文版Graphs API文档完整更新 — 中文版本与英文版保持一致，包括：(1)添加了"路径参数说明"部分明确说明graphspace和graph参数，(2)所有端点正确迁移到/graphspaces/DEFAULT/graphs/格式，(3)包含版本兼容性说明，(4)JSON配置体示例完整。Also applies to: 199-199, 229-229
content/en/docs/clients/restful-api/auth.md (5)
50-50: ✓ 身份验证API端点全面迁移 — 所有身份验证相关端点(用户、组、目标、关联、访问控制)都正确迁移到/graphspaces/DEFAULT/auth/...格式，与其他API文档保持一致。Also applies to: 84-84, 108-108, 152-152, 187-187, 218-218, 269-269, 301-301, 325-325, 366-366, 401-401, 462-462, 501-501, 525-525, 580-580, 639-639, 695-695, 726-726, 752-752, 793-793, 828-828, 882-882, 1072-1072, 1097-1097, 1138-1138, 1174-1174
69-69: ⚠ 用户标识符格式简化需验证 — 用户ID在响应中从复合格式(如"-63:boss")简化为简单名称(如"boss")。此更改简化了文档示例，但需要确认是否与实际API行为一致。建议验证：
- 这种简化是否反映了真实API响应的变化
- 后续使用这些ID的操作是否需要相应调整
Also applies to: 137-137, 171-171, 206-206
905-1062: ✓ 新增Graphspace Manager API文档完整 — 第10.7章节新增的Manager API文档包含5个完整的子操作(检查角色、列表、授予、撤销、查询)，具有以下特点：
- 路径结构清晰：
/graphspaces/{graphspace}/auth/managers- 前置条件明确：文档说明需要先创建graphspace(示例使用gs1)
- 参数文档完整：每个操作都包含参数、请求体、响应示例
- 角色类型完整：支持SPACE、SPACE_MEMBER、ADMIN等角色
286-286: ⚠ 组和目标标识符格式保持复合形式 — 与简化的用户ID不同，组ID(如"-69:all")和目标ID(如"-77:all")在示例中保持了复合格式。这种不一致可能会对API使用者造成混淆。建议：
- 明确说明为何用户ID简化而其他实体ID保持复合形式
- 或确保所有标识符格式保持一致(全部简化或全部保留复合形式)
Also applies to: 301-301, 325-325, 352-352, 385-385, 401-401, 418-418, 487-487
919-933: ✓ Manager API示例规范完整 — Manager API的五个操作(10.7.1-10.7.5)都包含了清晰的：
- 方法和URL示例
- 请求体(适用时)
- 参数说明
- 响应状态和响应体
格式与现有API文档保持一致。
Also applies to: 945-967, 984-1003, 1016-1030, 1040-1061
| ``` | ||
| PUT http://localhost:8080/graphs/hugegraph/jobs/rebuild/indexlabels/personByCity | ||
| PUT http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/jobs/rebuild/indexlabels/personByCity | ||
| ``` |
There was a problem hiding this comment.
缺少代码块语言标识。
代码块应指定语言类型（如 bash）以便语法高亮。建议在代码块开始处添加语言标识。
-```
+```bash
PUT http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/jobs/rebuild/indexlabels/personByCity
-```
+```🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
13-13: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
In content/en/docs/clients/restful-api/rebuild.md around lines 13 to 15, the
inline code block with the PUT request is missing a language identifier; update
the opening fence to include a language (e.g., bash) so it reads ```bash and
ensure the closing ``` remains, so the block is marked for proper syntax
highlighting.
| ``` | ||
| PUT http://localhost:8080/graphs/hugegraph/jobs/rebuild/vertexlabels/person | ||
| PUT http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/jobs/rebuild/vertexlabels/person | ||
| ``` |
There was a problem hiding this comment.
缺少代码块语言标识。
代码块应指定语言类型（如 bash）以便语法高亮。建议在代码块开始处添加语言标识。
-```
+```bash
PUT http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/jobs/rebuild/vertexlabels/person
-```
+```🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
38-38: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
In content/en/docs/clients/restful-api/rebuild.md around lines 38 to 40, the
fenced code block for the HTTP PUT example is missing a language identifier;
update the opening fence to include the appropriate language (e.g., bash) so the
block starts with ```bash and leave the closing fence unchanged, ensuring the
example renders with proper syntax highlighting.
| ``` | ||
| PUT http://localhost:8080/graphs/hugegraph/jobs/rebuild/edgelabels/created | ||
| PUT http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/jobs/rebuild/edgelabels/created | ||
| ``` |
There was a problem hiding this comment.
缺少代码块语言标识。
代码块应指定语言类型（如 bash）以便语法高亮。建议在代码块开始处添加语言标识。
-```
+```bash
PUT http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/jobs/rebuild/edgelabels/created
-```
+```🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
64-64: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
In content/en/docs/clients/restful-api/rebuild.md around lines 64 to 66, the
fenced code block is missing a language specifier; update the opening fence to
include a language (e.g., add "bash" after the initial ``` so it reads ```bash)
and ensure the closing ``` remains, so the HTTP example is rendered with proper
syntax highlighting.
| HugeGraph-Server通过HugeGraph-API基于HTTP协议为Client提供操作图的接口，主要包括元数据和 | ||
| HugeGraph-Server 通过 HugeGraph-API 基于 HTTP 协议为 Client 提供操作图的接口，主要包括元数据和 | ||
| 图数据的增删改查，遍历算法，变量，图操作及其他操作。 | ||
| 1.7.0 版本引入了图空间功能，若版本<1.7.0，api 路径需要去除 /graphspaces/{graphspace} |
There was a problem hiding this comment.
在主页面只简单提到了「1.7.0 版本引入了图空间功能,若版本<1.7.0,api 路径需要去除 /graphspaces/{graphspace}」,但这个说明不够充分:
- 应该在文档开头添加更醒目的版本说明,比如使用引用块(blockquote)或警告框
- 建议明确说明:
- v1.7.0+ 使用新路径:
/graphspaces/{graphspace}/graphs/{graph} - v1.6.x 及之前使用旧路径:
/graphs/{graph} - 默认图空间名称为
DEFAULT
- v1.7.0+ 使用新路径:
建议改进:
> ⚠️ **版本兼容性说明**
>
> - HugeGraph 1.7.0+ 引入了图空间功能,API 路径格式为: `/graphspaces/{graphspace}/graphs/{graph}`
> - HugeGraph 1.6.x 及之前版本使用旧路径: `/graphs/{graph}`
> - 默认图空间名称为 `DEFAULT`,可直接使用
| "user_creator": "admin", | ||
| "user_phone": "182****9088", | ||
| "id": "-63:boss", | ||
| "id": "boss", |
There was a problem hiding this comment.
这里的 id 字段缩进只有 2 个空格,而其他字段都是 4 个空格。建议统一缩进格式。
| "id": "boss", | |
| "user_name": "boss", | |
| "user_creator": "admin", | |
| "user_phone": "182****9088", | |
| "id": "boss", | |
| "user_create": "2020-11-17 14:31:07.833" |
| "user_creator": "admin", | ||
| "user_phone": "183****9266", | ||
| "id": "-63:test", | ||
| "id": "test", |
There was a problem hiding this comment.
多处出现相同的 JSON 缩进不一致问题。建议在整个文档中统一检查并修复所有 JSON 示例的格式。可以考虑使用 JSON formatter 工具进行批量格式化。
受影响的位置包括:
- auth.md 第 74, 141, 175, 191, 210 等多行
- 其他文件中可能也存在类似问题
| "id": "test", | |
| "user_name": "test", | |
| "user_creator": "admin", | |
| "user_phone": "183****9266", | |
| "id": "test", | |
| "user_create": "2020-11-12 10:27:13.601" |
|
|
||
| ### 10.7 图空间管理员（Manager）API | ||
|
|
||
| **重要提示**：在使用以下 API 之前，需要先创建图空间（graphspace）。请参考 [Graphspace API](../graphspace) 创建名为 `gs1` 的图空间。文档中的示例均假设已存在名为 `gs1` 的图空间 |
There was a problem hiding this comment.
这段重要提示出现在 Manager API 小节中（10.7），但它实际上是整个 auth.md 文档的前置条件。建议:
- 将图空间创建的前置说明移到文档开头（10.1 之前）
- 或者在每个需要图空间的 API 小节开头都添加简短提示
建议修改:
在文档开头（10.1 之前）添加:
## 前置条件
使用以下 API 之前,需要确保:
1. 已创建对应的图空间。参考 [Graphspace API](../graphspace) 创建图空间
2. 本文档示例中使用的图空间名称为 `gs1` 和 `DEFAULT`
| ```json | ||
| "true" | ||
| ``` | ||
|
|
There was a problem hiding this comment.
这个接口返回的是纯字符串 "true"/"false",而不是标准的 JSON boolean 值。建议:
- 如果这是后端实际行为,建议在文档中明确说明这是字符串类型
- 推荐后端团队考虑在未来版本中改为返回标准 JSON:
{"hasRole": true}
当前文档建议改进:
##### Response Body
返回字符串类型的布尔值:
- `"true"`: 拥有指定角色
- `"false"`: 不拥有指定角色
注意:返回值为字符串类型,而非 JSON boolean。
|
|
||
| ##### Response Body | ||
|
|
||
| ```json |
There was a problem hiding this comment.
新增的 Manager API 文档中,只有部分接口有明确的 Params 说明。建议为所有接口补充完整的参数说明,包括:
- 路径参数 (graphspace, user, type 等)
- 查询参数 (page, limit 等,如果有)
- 参数的必填/选填说明
- 参数的取值范围或格式要求
示例格式:
##### Params
**路径参数:**
- graphspace: 图空间名称 (必填)
- user: 用户 ID (必填)
- type: 角色类型 (选填),可选值: `SPACE`, `SPACE_MEMBER`, `ADMIN`
| } | ||
| ``` | ||
|
|
||
| > 注意：对于 HugeGraph 1.5.0 及之前版本，此接口的请求体仍需使用 `text/plain`（properties 文本）格式，而不是 JSON。 |
There was a problem hiding this comment.
在第 199 行添加了一个注意事项,说明「对于 HugeGraph 1.5.0 及之前版本,此接口的请求体仍需使用 text/plain(properties 文本)格式」,但是:
- 这个说明只出现在创建图的接口后面,删除图接口后面也有类似说明
- 应该统一说明哪个版本开始支持 JSON 格式(看起来是 1.6.0 或 1.7.0?)
- 建议在文档开头统一说明 API 格式的版本差异
建议: 在 6.1 节开头添加统一的版本说明,然后删除分散在各处的重复说明。
There was a problem hiding this comment.
Actionable comments posted: 3
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
content/en/docs/clients/restful-api/graphs.md (1)
16-17:⚠️ API 路径不一致：列出图表端点尚未迁移6.1.1 节的 "List all graphs" 端点仍然使用旧路径
/graphs，而其他所有端点都已迁移到/graphspaces/DEFAULT/graphs。建议更新此端点以保持一致性：-GET http://localhost:8080/graphs +GET http://localhost:8080/graphspaces/DEFAULT/graphs
🧹 Nitpick comments (4)
content/cn/docs/clients/restful-api/graphspace.md (2)
22-22: 为代码块添加语言标识符多个代码块（第 22、101、132、202、271 行等）缺少语言标识符。请在 ``` 后添加
http以提高代码可读性和语法高亮显示。示例修改：
-\`\`\` +\`\`\`http POST http://localhost:8080/graphspaces -\`\`\` +\`\`\`同样的修改应适用于所有 HTTP 方法的代码块。
Also applies to: 101-101, 132-132, 202-202, 271-271
65-67: 为 JSON 响应码代码块添加语言标识符多个仅包含 HTTP 状态码的代码块缺少语言标识符。请在 ``` 后添加
json标识。示例修改：
-\`\`\` +\`\`\`json 201 -\`\`\` +\`\`\`这适用于所有响应状态码的代码块（第 65、107、137、229、276 行）。
Also applies to: 107-108, 137-139, 229-231, 276-278
content/en/docs/clients/restful-api/graphspace.md (1)
11-11: 📝 建议修复 Markdown 样式问题根据 markdownlint 工具提示，以下强调文本应转换为标题：
- 第 11 行："Prerequisites" → 应为
### Prerequisites- 第 125 行："Path parameters" → 应为
#### Path parameters- 第 174 行："Path parameter" → 应为
#### Path parameter- 第 178 行："Request parameters" → 应为
#### Request parameters- 第 264 行："Path parameter" → 应为
#### Path parameter此外，代码块应指定语言类型，如第 22、100、131、202、270 行应使用
```json而非```。Also applies to: 125-125, 174-174, 178-178, 264-264
content/en/docs/clients/restful-api/auth.md (1)
1058-1058: 📝 建议补齐代码块语言声明以下代码块缺少语言类型声明，建议修复以符合 Markdown 最佳实践：
- 第 1058 行、1084 行、1123 行、1155 行、1179 行：应使用
```json而非```Also applies to: 1084-1084, 1123-1123, 1155-1155, 1179-1179
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (8)
content/cn/docs/clients/restful-api/_index.md(1 hunks)content/cn/docs/clients/restful-api/auth.md(36 hunks)content/cn/docs/clients/restful-api/graphs.md(15 hunks)content/cn/docs/clients/restful-api/graphspace.md(1 hunks)content/en/docs/clients/restful-api/_index.md(1 hunks)content/en/docs/clients/restful-api/auth.md(40 hunks)content/en/docs/clients/restful-api/graphs.md(14 hunks)content/en/docs/clients/restful-api/graphspace.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
content/en/docs/clients/restful-api/graphspace.md
[style] ~280-~280: Replacing this phrase with a shorter alternative might make your text sound more refined.
Context: ... graphspace releases all resources that belong to it.
(BELONG_TO_PRP)
🪛 markdownlint-cli2 (0.18.1)
content/en/docs/clients/restful-api/graphspace.md
11-11: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
22-22: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
100-100: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
125-125: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
131-131: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
174-174: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
178-178: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
202-202: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
264-264: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
270-270: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/en/docs/clients/restful-api/auth.md
1058-1058: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1084-1084: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1123-1123: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1155-1155: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1179-1179: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/cn/docs/clients/restful-api/graphspace.md
15-15: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
40-40: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
73-73: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
93-93: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
135-135: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
185-185: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
240-240: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
241-241: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
243-243: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
248-248: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
249-249: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
251-251: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
252-252: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
262-262: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/en/docs/clients/restful-api/_index.md
11-11: Heading levels should only increment by one level at a time
Expected: h4; Actual: h5
(MD001, heading-increment)
🔇 Additional comments (13)
content/en/docs/clients/restful-api/_index.md (1)
7-12: ✓ 版本兼容性说明清晰有效新增的版本兼容性提示框结构良好，清楚地说明了不同版本的 API 路径差异、认证要求和默认图空间名称。这对用户理解 API 升级路径非常有帮助。
content/cn/docs/clients/restful-api/_index.md (1)
7-11: ✓ 版本兼容性说明已改进中文版本现已清楚说明了不同版本间的差异，包括 Content-Type 的使用差异（text/plain vs JSON），与英文版保持一致。这解决了之前评论中提出的明确性问题。
content/cn/docs/clients/restful-api/graphs.md (3)
9-9: ✓ 认证要求提示恰当关于 HugeGraph 1.7.0+ 版本必须开启鉴权模式创建图的提示放置在合适的位置，帮助用户避免配置错误。
13-50: ✓ 路径参数文档齐全新增的路径参数说明（graphspace、graph）对每个 API 端点都进行了清晰的定义，有助于用户理解新的图空间作用域 API 结构。
120-131: ✓ 请求体格式正确更新Request Body 格式已正确更新为 JSON，并在注释中明确说明需要设置
Content-Type: application/json。这与版本兼容性说明一致。Also applies to: 169-179
content/cn/docs/clients/restful-api/auth.md (2)
1044-1048: ✓ 图空间管理员 API 文档完整新增的 10.7 图空间管理员 API 文档清晰完整，包含了检查角色、列出管理员、授权、撤销权限和查询角色等主要操作。前置条件说明恰当，示例使用 gs1 作为参考。
1050-1075: ✓ 角色检查 API 文档明确清楚说明返回值为字符串类型 "true"/"false" 而非 JSON boolean，这种明确的类型说明有助于用户正确解析响应。
content/en/docs/clients/restful-api/graphs.md (2)
9-9: ✓ 认证要求提示恰当关于 HugeGraph 1.7.0+ 版本必须开启鉴权模式创建图的提示清晰明确。
99-110: ✓ 请求体格式正确JSON 请求体格式已正确更新，并清晰说明需要设置
Content-Type: application/json。Also applies to: 141-151
content/en/docs/clients/restful-api/graphspace.md (2)
11-16: ✓ 前置条件说明完整前置条件部分清晰说明了 Graphspace 功能的限制条件（HStore 模式、默认图空间、认证要求），帮助用户正确配置环境。
18-94: ✓ 创建图空间文档完整创建图空间 API 的文档详尽，包含了完整的参数说明表、请求/响应示例。参数范围和验证规则清晰易懂。
content/en/docs/clients/restful-api/auth.md (2)
1044-1048: ✓ 图空间管理员 API 文档完整英文版本的 10.7 Graphspace Manager API 文档与中文版本保持一致，包含了完整的操作说明和明确的前置条件。
50-1022: ✓ 认证 API 路径迁移完整所有认证相关 API 端点已成功迁移至图空间作用域（
/graphspaces/DEFAULT/auth/），简化的 ID 格式应用一致，与中文版本保持同步。
There was a problem hiding this comment.
Actionable comments posted: 6
♻️ Duplicate comments (6)
content/cn/docs/clients/restful-api/cypher.md (2)
32-34: 示例 URL 应该为单行格式。GET 请求方法和 URL 应该合并为单行，便于用户复制使用：
-GET -http://localhost:8080/graphspaces/DEFAULT/graphs/hugecypher1/cypher?cypher=match(n:person) return n.name as name order by n.name limit 1 +GET http://localhost:8080/graphspaces/DEFAULT/graphs/hugecypher1/cypher?cypher=match(n:person) return n.name as name order by n.name limit 1
92-94: 示例 URL 应该为单行格式。POST 请求方法和 URL 应该合并为单行，便于用户复制使用：
-POST -http://localhost:8080/graphspaces/DEFAULT/graphs/hugecypher1/cypher +POST http://localhost:8080/graphspaces/DEFAULT/graphs/hugecypher1/cyphercontent/en/docs/clients/restful-api/rebuild.md (1)
14-14: 路径迁移已正确完成，代码块语言标识问题仍需处理。Rebuild端点的路径已按预期更新至graphspaces作用域。但第14、39、65行的代码块仍缺少语言标识（bash），之前的review中已提及此问题，建议立即修复。
Also applies to: 39-39, 65-65
content/cn/docs/clients/restful-api/auth.md (1)
74-76: JSON格式缩进不一致（重复问题）多处Response Body示例中，
"id"字段的缩进为2个空格，而其他字段为4个空格。这是之前审查指出过的问题，建议统一调整所有JSON示例为4个空格缩进。示例位置：第74-76行、141-142行、175-176行、210-211行等。"user_creator": "admin", "user_phone": "182****9088", - "id": "boss", + "id": "boss", "user_create": "2020-11-17 14:31:07.833"Also applies to: 141-142, 175-176, 210-211
content/cn/docs/clients/restful-api/graphspace.md (2)
49-94: 创建图空间的请求/响应示例中 memory_limit 值不一致创建请求体（第 55 行）指定
"memory_limit": 8192，但响应体（第 76 行）返回"memory_limit": 1024。HTTP 201 响应应当反映实际创建的资源状态。请更新响应体示例中的 memory_limit 值为 8192，或在文档中说明为何服务端会修改此值。建议修正响应体：
"name": "gs1", "description": "1st graph space", "cpu_limit": 1000, - "memory_limit": 1024, + "memory_limit": 8192, "storage_limit": 1000,
208-258: 更新操作的响应值未反映请求中的更新内容更新请求（第 209-225 行）明确指定了新值，但响应体（第 233-258 行）中多个字段仍保持原始值：
字段 请求值 响应值 应为 memory_limit 40960 1024 ✗ storage_limit 2048 1000 ✗ max_graph_number 1000 100 ✗ max_role_number 100 10 ✗ HTTP 200 响应应展示更新成功后的完整状态。请更新响应体示例以反映实际的更新结果。
建议修正响应体：
"name": "gs1", "description": "1st graph space", "cpu_limit": 2000, - "memory_limit": 1024, - "storage_limit": 1000, + "memory_limit": 40960, + "storage_limit": 2048, "oltp_namespace": "hugegraph-server", "olap_namespace": "hugegraph-server", "storage_namespace": "hugegraph-server", "operator_image_path": "127.0.0.1/hugegraph-registry/hugegraph-computer-operator:3.1.1", "internal_algorithm_image_url": "127.0.0.1/hugegraph-registry/hugegraph-computer-algorithm:3.1.1", "compute_cpu_limit": 0, "compute_memory_limit": 0, - "max_graph_number": 100, - "max_role_number": 10, + "max_graph_number": 1000, + "max_role_number": 100, "cpu_used": 0, "memory_used": 0, "storage_used": 0, "graph_number_used": 0, "role_number_used": 0, "auth": true }
🧹 Nitpick comments (14)
content/cn/docs/clients/restful-api/_index.md (1)
7-12: ✅ 很好地解决了前一次审查的关键问题本次变更很好地实现了之前审查意见的建议，添加了更醒目的版本兼容性说明blockquote，使用警告符号提高了可视性，明确区分了不同版本的API路径格式和默认图空间名称。这将显著改善文档用户的理解。
可选改进建议：
版本覆盖范围：文档提及1.7.0+和1.5.x及之前，但1.6.x版本的兼容性未明确说明。建议补充说明1.6.x应使用哪种API格式。
Content-Type变更说明：第10行的表述较为冗长。建议改进为更结构化的格式，例如：
> - HugeGraph 1.7.0+ 使用 JSON 格式调用 API > - HugeGraph 1.6.x 及之前版本创建/克隆图的 API 使用 text/plain 作为 Content-Type这样可以使版本差异更一目了然。
content/cn/docs/clients/restful-api/variable.md (1)
16-16: 核实路径前缀迁移的一致性。URLs已正确更新为graphspaces前缀。但第46行存在Markdown格式问题：代码块中含有硬制表符（hard tab）。建议将其替换为空格以保持代码风格一致。
-GET http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/variables +GET http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/variables（使用空格替代制表符）
Also applies to: 46-46, 68-68, 90-90
content/cn/docs/clients/restful-api/propertykey.md (2)
26-27: 代码块缺少语言标记根据 markdownlint 检查，第26行的URL代码块应指定语言类型。由于这是HTTP请求URL，建议使用纯文本格式或直接移除代码块标记。
-``` +``` POST http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/schema/propertykeys -``` +```建议改为:
-``` +```http POST http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/schema/propertykeys -``` +```
203-204: 代码块缺少语言标记（第203-204行）第203行的URL代码块同样缺少语言标记。建议统一使用
http或空标记指定所有URL示例的代码块格式。content/cn/docs/clients/restful-api/indexlabel.md (1)
15-17: 代码块缺少语言标记文件中多处URL代码块（行15、61、125、156）缺少语言标记。建议统一为HTTP相关的代码块添加
http或curl标记，以符合 markdownlint 标准。Also applies to: 61-63, 125-127, 156-158
content/cn/docs/clients/restful-api/graphs.md (2)
13-13: 代码块缺少语言标记第13行和其他URL代码块缺少语言标记。建议统一添加
http或json标记。Also applies to: 220-221
9-10: 版本提醒内容合理，但与后续版本说明可能存在重复第9-10行新增的"重要提醒"关于1.7.0鉴权要求很有用。但第231行的版本兼容性说明（关于1.5.0 text/plain格式）与之并存，建议在文档开头统一说明各版本的API格式差异，避免信息分散。
content/cn/docs/clients/restful-api/auth.md (3)
1044-1046: 前置条件说明位置和内容Manager API部分（10.7）新增的前置说明"需要先创建图空间（graphspace）gs1"很有帮助。但建议：
- 在第1046行的前置说明中更明确地说明参数含义（例如"graphspace: gs1"、"图空间名称: gs1"）
- 考虑在10.1开头统一提供一个"前置条件"部分，说明本文档示例使用的图空间（DEFAULT和gs1）
1050-1074: Manager API参数说明不够完整10.7.1（check接口）中：
- Params部分只说明了"type: 需要校验的角色类型，可选"，但缺少对路径参数"graphspace"的说明
- Response Body返回的是字符串
"true"，建议明确说明这是字符串类型而非JSON boolean建议添加完整的Params说明：
##### Params **路径参数：** - graphspace: 图空间名称 **查询参数：** - type: 需要校验的角色类型，可选
1058-1058: 代码块缺少语言标记Manager API部分的多个代码块（行1058、1084、1123、1155、1179）缺少语言标记。建议统一为
http格式。Also applies to: 1084-1084, 1123-1123, 1155-1155, 1179-1179
content/cn/docs/clients/restful-api/vertex.md (2)
433-433: 粗体文本用作标题（MD036）多个位置使用粗体代替Markdown标题语法，例如：
- 第433行：
**查询所有 age 为 29 且 label 为 person 的顶点**- 第465行：
**分页查询所有顶点，获取第一页...**- 第532行：
**分页查询所有顶点，获取下一页...**- 第638行：
**仅根据 Id 删除顶点**- 第652行：
**根据 Label+Id 删除顶点**建议改为使用Markdown标题语法
#####以保持一致性。Also applies to: 465-465, 532-532, 638-638, 652-652
54-54: 代码块缺少语言标记多处URL代码块缺少语言标记（MD040）。建议统一为
http或shell格式（如果是curl命令）。Also applies to: 101-101, 154-154, 257-257, 363-363, 437-437, 475-475, 536-536, 600-600, 642-642, 658-658
content/en/docs/clients/restful-api/graphspace.md (2)
25-25: 代码块缺少语言标记新增的Graphspace API文档中，多个JSON代码块缺少语言标记。建议统一为
json格式（行25、74、123、202、238）。-``` +```json { "name": "gs1", ... } -``` +```Also applies to: 74-74, 123-123, 202-202, 238-238
270-271: HTTP方法代码块缺少语言标记第270行的DELETE方法代码块也缺少语言标记，建议添加
http标记。
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (37)
content/cn/docs/clients/restful-api/_index.md(1 hunks)content/cn/docs/clients/restful-api/auth.md(36 hunks)content/cn/docs/clients/restful-api/cypher.md(2 hunks)content/cn/docs/clients/restful-api/edge.md(18 hunks)content/cn/docs/clients/restful-api/edgelabel.md(7 hunks)content/cn/docs/clients/restful-api/graphs.md(15 hunks)content/cn/docs/clients/restful-api/graphspace.md(1 hunks)content/cn/docs/clients/restful-api/gremlin.md(7 hunks)content/cn/docs/clients/restful-api/indexlabel.md(5 hunks)content/cn/docs/clients/restful-api/propertykey.md(5 hunks)content/cn/docs/clients/restful-api/rank.md(4 hunks)content/cn/docs/clients/restful-api/rebuild.md(4 hunks)content/cn/docs/clients/restful-api/schema.md(2 hunks)content/cn/docs/clients/restful-api/task.md(4 hunks)content/cn/docs/clients/restful-api/traverser.md(40 hunks)content/cn/docs/clients/restful-api/variable.md(4 hunks)content/cn/docs/clients/restful-api/vertex.md(14 hunks)content/cn/docs/clients/restful-api/vertexlabel.md(7 hunks)content/cn/docs/quickstart/hugegraph/hugegraph-server.md(4 hunks)content/en/docs/clients/restful-api/_index.md(1 hunks)content/en/docs/clients/restful-api/auth.md(40 hunks)content/en/docs/clients/restful-api/edge.md(11 hunks)content/en/docs/clients/restful-api/edgelabel.md(6 hunks)content/en/docs/clients/restful-api/graphs.md(14 hunks)content/en/docs/clients/restful-api/graphspace.md(1 hunks)content/en/docs/clients/restful-api/gremlin.md(3 hunks)content/en/docs/clients/restful-api/indexlabel.md(5 hunks)content/en/docs/clients/restful-api/propertykey.md(5 hunks)content/en/docs/clients/restful-api/rank.md(2 hunks)content/en/docs/clients/restful-api/rebuild.md(4 hunks)content/en/docs/clients/restful-api/schema.md(1 hunks)content/en/docs/clients/restful-api/task.md(4 hunks)content/en/docs/clients/restful-api/traverser.md(7 hunks)content/en/docs/clients/restful-api/variable.md(4 hunks)content/en/docs/clients/restful-api/vertex.md(11 hunks)content/en/docs/clients/restful-api/vertexlabel.md(6 hunks)content/en/docs/quickstart/hugegraph/hugegraph-server.md(6 hunks)
🚧 Files skipped from review as they are similar to previous changes (10)
- content/en/docs/clients/restful-api/schema.md
- content/en/docs/clients/restful-api/rank.md
- content/en/docs/clients/restful-api/vertexlabel.md
- content/en/docs/clients/restful-api/edgelabel.md
- content/en/docs/clients/restful-api/propertykey.md
- content/cn/docs/quickstart/hugegraph/hugegraph-server.md
- content/en/docs/clients/restful-api/_index.md
- content/en/docs/clients/restful-api/traverser.md
- content/en/docs/clients/restful-api/indexlabel.md
- content/en/docs/quickstart/hugegraph/hugegraph-server.md
🧰 Additional context used
🪛 LanguageTool
content/cn/docs/clients/restful-api/rank.md
[uncategorized] ~127-~127: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：共同"地"打分
Context: ...如果决定向外游走，那么会选取某一个类型的出边，例如 rating 来查找共同的打分人： 1. 那就从当前节点的邻居节点中按照均匀分布随机选择一个，并且按...
(wb4)
content/en/docs/clients/restful-api/rebuild.md
[grammar] ~32-~32: Ensure spelling is correct
Context: ...d here should be 1). See More AsyncJob RESTfull API #### 1.6.2 Rebulid all I...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~34-~34: Ensure spelling is correct
Context: ...cJob RESTfull API](../task) #### 1.6.2 Rebulid all Indexs of VertexLabel ##### Method...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~34-~34: Ensure spelling is correct
Context: ...l API](../task) #### 1.6.2 Rebulid all Indexs of VertexLabel ##### Method & Url ```...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~58-~58: Ensure spelling is correct
Context: ...d here should be 2). See More AsyncJob RESTfull API #### 1.6.3 Rebulid all I...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~60-~60: Ensure spelling is correct
Context: ...cJob RESTfull API](../task) #### 1.6.3 Rebulid all Indexs of EdgeLabel ##### Method &...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~60-~60: Ensure spelling is correct
Context: ...l API](../task) #### 1.6.3 Rebulid all Indexs of EdgeLabel ##### Method & Url ``` P...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~84-~84: Ensure spelling is correct
Context: ...d here should be 3). See More AsyncJob RESTfull API
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
content/cn/docs/clients/restful-api/traverser.md
[uncategorized] ~13-~13: 您的意思是“"不"可”？
Context: ...rser API 包括： - K-out API，根据起始顶点，查找恰好 N 步可达的邻居，分为基础版和高级版： - 基础版使用 GET 方法，根据起始...
(BU)
[uncategorized] ~14-~14: 您的意思是“"不"可”？
Context: ...版和高级版： - 基础版使用 GET 方法，根据起始顶点，查找恰好 N 步可达的邻居 - 高级版使用 POST 方法，根据起始顶点，查找恰好 N ...
(BU)
[uncategorized] ~15-~15: 您的意思是“"不"可”？
Context: ...可达的邻居 - 高级版使用 POST 方法，根据起始顶点，查找恰好 N 步可达的邻居，与基础版的不同在于： - 支持只统计邻居数量 ...
(BU)
[uncategorized] ~19-~19: 您的意思是“"不"以内”？
Context: ...回到达邻居的最短路径 - K-neighbor API，根据起始顶点，查找 N 步以内可达的所有邻居，分为基础版和高级版： - 基础版使用 GET 方法，...
(BU)
[uncategorized] ~20-~20: 您的意思是“"不"以内”？
Context: ...基础版和高级版： - 基础版使用 GET 方法，根据起始顶点，查找 N 步以内可达的所有邻居 - 高级版使用 POST 方法，根据起始顶点，查找 ...
(BU)
[uncategorized] ~21-~21: 您的意思是“"不"以内”？
Context: ...可达的所有邻居 - 高级版使用 POST 方法，根据起始顶点，查找 N 步以内可达的所有邻居，与基础版的不同在于： - 支持只统计邻居数量...
(BU)
[uncategorized] ~197-~197: 您的意思是“"不"可”？
Context: ...、方向、边的类型（可选）和深度 depth，查找从起始顶点出发恰好 depth 步可达的顶点 ###### Params - source：起始顶点 id，必...
(BU)
[uncategorized] ~237-~237: 您的意思是“"不"关系”？
Context: ... ] } ``` ##### 3.2.1.3 适用场景 查找恰好 N 步关系可达的顶点。两个例子： - 家族关系中，查找一个人的所有孙子，person...
(BU)
[uncategorized] ~246-~246: 您的意思是“"不"可”？
Context: ...方向、边类型和过滤属性）和深度 depth，查找从起始顶点出发恰好 depth 步可达的顶点。 > 与 K-out 基础版的不同在于： > - 支持只统计邻居数...
(BU)
[uncategorized] ~438-~438: 您的意思是“"不"之内”？
Context: ...点、方向、边的类型（可选）和深度 depth，查找包括起始顶点在内、depth 步之内可达的所有顶点 > 相当于：起始顶点、K-out(1)、K-out(2)、...
(BU)
[uncategorized] ~482-~482: 您的意思是“"不"以内”？
Context: ..." ] } ``` ##### 3.2.3.3 适用场景 查找 N 步以内可达的所有顶点，例如： - 家族关系中，查找一个人五服以内所有子孙，per...
(BU)
[uncategorized] ~492-~492: 您的意思是“"不"内”？
Context: ...包括方向、边类型和过滤属性）和深度 depth，查找从起始顶点出发 depth 步内可达的所有顶点。 > 与 K-neighbor 基础版的不同在于： > - ...
(BU)
[uncategorized] ~1649-~1649: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：重"地"降
Context: ...- INCR 表示按照路径权重的升序排序 - DECR 表示按照路径权重的降序排序 - capacity：遍历过程中最大的访问的顶点数目，选填项，默认为 ...
(wb4)
content/en/docs/clients/restful-api/graphspace.md
[style] ~280-~280: Replacing this phrase with a shorter alternative might make your text sound more refined.
Context: ... graphspace releases all resources that belong to it.
(BELONG_TO_PRP)
🪛 markdownlint-cli2 (0.18.1)
content/en/docs/clients/restful-api/vertex.md
228-228: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
429-429: Multiple headings with the same content
(MD024, no-duplicate-heading)
431-431: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/cn/docs/clients/restful-api/graphs.md
11-11: Heading levels should only increment by one level at a time
Expected: h4; Actual: h5
(MD001, heading-increment)
13-13: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/cn/docs/clients/restful-api/edge.md
588-588: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/cn/docs/clients/restful-api/rank.md
144-144: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
145-145: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
146-146: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
155-155: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
302-302: Inconsistent indentation for list items at the same level
Expected: 1; Actual: 4
(MD005, list-indent)
302-302: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
303-303: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
303-303: Hard tabs
Column: 1
(MD010, no-hard-tabs)
310-310: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/en/docs/clients/restful-api/auth.md
1058-1058: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1084-1084: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1123-1123: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1155-1155: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1179-1179: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/cn/docs/clients/restful-api/vertex.md
54-54: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
101-101: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
154-154: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
257-257: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
363-363: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
433-433: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
437-437: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
465-465: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
473-473: Multiple headings with the same content
(MD024, no-duplicate-heading)
475-475: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
532-532: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
534-534: Multiple headings with the same content
(MD024, no-duplicate-heading)
536-536: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
600-600: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
638-638: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
642-642: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
652-652: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
656-656: Multiple headings with the same content
(MD024, no-duplicate-heading)
658-658: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/cn/docs/clients/restful-api/variable.md
46-46: Hard tabs
Column: 1
(MD010, no-hard-tabs)
content/cn/docs/clients/restful-api/indexlabel.md
15-15: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
61-61: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
125-125: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
156-156: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/cn/docs/clients/restful-api/auth.md
1058-1058: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1084-1084: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1123-1123: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1155-1155: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1179-1179: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/en/docs/clients/restful-api/rebuild.md
38-38: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
64-64: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/cn/docs/clients/restful-api/edgelabel.md
26-26: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
188-188: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
250-250: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
293-293: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/cn/docs/clients/restful-api/graphspace.md
18-18: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
22-22: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
36-36: Hard tabs
Column: 1
(MD010, no-hard-tabs)
37-37: Hard tabs
Column: 1
(MD010, no-hard-tabs)
38-38: Hard tabs
Column: 1
(MD010, no-hard-tabs)
39-39: Hard tabs
Column: 1
(MD010, no-hard-tabs)
40-40: Hard tabs
Column: 1
(MD010, no-hard-tabs)
41-41: Hard tabs
Column: 1
(MD010, no-hard-tabs)
42-42: Hard tabs
Column: 1
(MD010, no-hard-tabs)
43-43: Hard tabs
Column: 1
(MD010, no-hard-tabs)
44-44: Hard tabs
Column: 1
(MD010, no-hard-tabs)
45-45: Hard tabs
Column: 1
(MD010, no-hard-tabs)
46-46: Hard tabs
Column: 1
(MD010, no-hard-tabs)
47-47: Hard tabs
Column: 1
(MD010, no-hard-tabs)
48-48: Hard tabs
Column: 1
(MD010, no-hard-tabs)
49-49: Hard tabs
Column: 1
(MD010, no-hard-tabs)
50-50: Hard tabs
Column: 1
(MD010, no-hard-tabs)
51-51: Hard tabs
Column: 1
(MD010, no-hard-tabs)
52-52: Hard tabs
Column: 1
(MD010, no-hard-tabs)
53-53: Hard tabs
Column: 1
(MD010, no-hard-tabs)
54-54: Hard tabs
Column: 1
(MD010, no-hard-tabs)
55-55: Hard tabs
Column: 1
(MD010, no-hard-tabs)
56-56: Hard tabs
Column: 1
(MD010, no-hard-tabs)
57-57: Hard tabs
Column: 1
(MD010, no-hard-tabs)
58-58: Hard tabs
Column: 1
(MD010, no-hard-tabs)
59-59: Hard tabs
Column: 1
(MD010, no-hard-tabs)
60-60: Hard tabs
Column: 1
(MD010, no-hard-tabs)
61-61: Hard tabs
Column: 1
(MD010, no-hard-tabs)
62-62: Hard tabs
Column: 1
(MD010, no-hard-tabs)
63-63: Hard tabs
Column: 1
(MD010, no-hard-tabs)
71-71: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
75-75: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
81-81: Hard tabs
Column: 1
(MD010, no-hard-tabs)
82-82: Hard tabs
Column: 1
(MD010, no-hard-tabs)
83-83: Hard tabs
Column: 1
(MD010, no-hard-tabs)
84-84: Hard tabs
Column: 1
(MD010, no-hard-tabs)
98-98: Hard tabs
Column: 1
(MD010, no-hard-tabs)
99-99: Hard tabs
Column: 1
(MD010, no-hard-tabs)
100-100: Hard tabs
Column: 1
(MD010, no-hard-tabs)
101-101: Hard tabs
Column: 1
(MD010, no-hard-tabs)
102-102: Hard tabs
Column: 1
(MD010, no-hard-tabs)
103-103: Hard tabs
Column: 1
(MD010, no-hard-tabs)
104-104: Hard tabs
Column: 1
(MD010, no-hard-tabs)
105-105: Hard tabs
Column: 1
(MD010, no-hard-tabs)
106-106: Hard tabs
Column: 1
(MD010, no-hard-tabs)
107-107: Hard tabs
Column: 1
(MD010, no-hard-tabs)
108-108: Hard tabs
Column: 1
(MD010, no-hard-tabs)
109-109: Hard tabs
Column: 1
(MD010, no-hard-tabs)
110-110: Hard tabs
Column: 1
(MD010, no-hard-tabs)
111-111: Hard tabs
Column: 1
(MD010, no-hard-tabs)
112-112: Hard tabs
Column: 1
(MD010, no-hard-tabs)
113-113: Hard tabs
Column: 1
(MD010, no-hard-tabs)
114-114: Hard tabs
Column: 1
(MD010, no-hard-tabs)
115-115: Hard tabs
Column: 1
(MD010, no-hard-tabs)
116-116: Hard tabs
Column: 1
(MD010, no-hard-tabs)
117-117: Hard tabs
Column: 1
(MD010, no-hard-tabs)
118-118: Hard tabs
Column: 1
(MD010, no-hard-tabs)
119-119: Hard tabs
Column: 1
(MD010, no-hard-tabs)
120-120: Hard tabs
Column: 1
(MD010, no-hard-tabs)
121-121: Hard tabs
Column: 1
(MD010, no-hard-tabs)
122-122: Hard tabs
Column: 1
(MD010, no-hard-tabs)
123-123: Hard tabs
Column: 1
(MD010, no-hard-tabs)
124-124: Hard tabs
Column: 1
(MD010, no-hard-tabs)
125-125: Hard tabs
Column: 1
(MD010, no-hard-tabs)
135-135: Blank line inside blockquote
(MD028, no-blanks-blockquote)
138-138: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
140-140: Multiple headings with the same content
(MD024, no-duplicate-heading)
144-144: Hard tabs
Column: 1
(MD010, no-hard-tabs)
145-145: Hard tabs
Column: 1
(MD010, no-hard-tabs)
146-146: Hard tabs
Column: 1
(MD010, no-hard-tabs)
147-147: Hard tabs
Column: 1
(MD010, no-hard-tabs)
148-148: Hard tabs
Column: 1
(MD010, no-hard-tabs)
149-149: Hard tabs
Column: 1
(MD010, no-hard-tabs)
150-150: Hard tabs
Column: 1
(MD010, no-hard-tabs)
154-154: Multiple headings with the same content
(MD024, no-duplicate-heading)
160-160: Multiple headings with the same content
(MD024, no-duplicate-heading)
164-164: Hard tabs
Column: 1
(MD010, no-hard-tabs)
165-165: Hard tabs
Column: 1
(MD010, no-hard-tabs)
166-166: Hard tabs
Column: 1
(MD010, no-hard-tabs)
167-167: Hard tabs
Column: 1
(MD010, no-hard-tabs)
168-168: Hard tabs
Column: 1
(MD010, no-hard-tabs)
169-169: Hard tabs
Column: 1
(MD010, no-hard-tabs)
170-170: Hard tabs
Column: 1
(MD010, no-hard-tabs)
171-171: Hard tabs
Column: 1
(MD010, no-hard-tabs)
172-172: Hard tabs
Column: 1
(MD010, no-hard-tabs)
173-173: Hard tabs
Column: 1
(MD010, no-hard-tabs)
174-174: Hard tabs
Column: 1
(MD010, no-hard-tabs)
175-175: Hard tabs
Column: 1
(MD010, no-hard-tabs)
176-176: Hard tabs
Column: 1
(MD010, no-hard-tabs)
177-177: Hard tabs
Column: 1
(MD010, no-hard-tabs)
178-178: Hard tabs
Column: 1
(MD010, no-hard-tabs)
179-179: Hard tabs
Column: 1
(MD010, no-hard-tabs)
180-180: Hard tabs
Column: 1
(MD010, no-hard-tabs)
181-181: Hard tabs
Column: 1
(MD010, no-hard-tabs)
182-182: Hard tabs
Column: 1
(MD010, no-hard-tabs)
183-183: Hard tabs
Column: 1
(MD010, no-hard-tabs)
184-184: Hard tabs
Column: 1
(MD010, no-hard-tabs)
185-185: Hard tabs
Column: 1
(MD010, no-hard-tabs)
193-193: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
197-197: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
203-203: Hard tabs
Column: 1
(MD010, no-hard-tabs)
204-204: Hard tabs
Column: 1
(MD010, no-hard-tabs)
205-205: Hard tabs
Column: 1
(MD010, no-hard-tabs)
206-206: Hard tabs
Column: 1
(MD010, no-hard-tabs)
225-225: Hard tabs
Column: 1
(MD010, no-hard-tabs)
233-233: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
235-235: Multiple headings with the same content
(MD024, no-duplicate-heading)
239-239: Hard tabs
Column: 1
(MD010, no-hard-tabs)
240-240: Hard tabs
Column: 1
(MD010, no-hard-tabs)
241-241: Hard tabs
Column: 1
(MD010, no-hard-tabs)
242-242: Hard tabs
Column: 1
(MD010, no-hard-tabs)
246-246: Multiple headings with the same content
(MD024, no-duplicate-heading)
252-252: Multiple headings with the same content
(MD024, no-duplicate-heading)
256-256: Hard tabs
Column: 1
(MD010, no-hard-tabs)
content/cn/docs/clients/restful-api/gremlin.md
135-135: Blank line inside blockquote
(MD028, no-blanks-blockquote)
193-193: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/cn/docs/clients/restful-api/propertykey.md
26-26: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
203-203: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/cn/docs/clients/restful-api/rebuild.md
13-13: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
39-39: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
65-65: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/cn/docs/clients/restful-api/traverser.md
47-47: Link fragments should be valid
(MD051, link-fragments)
content/en/docs/clients/restful-api/graphspace.md
25-25: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
74-74: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
123-123: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
202-202: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
238-238: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (19)
content/cn/docs/clients/restful-api/cypher.md (2)
18-27: 参数说明结构清晰。新增的路径参数说明（graphspace 和 graph）已正确补充，请求参数说明也已更新。结构合理，符合 API 文档规范。
75-88: Body 参数说明准确，纯文本注明正确。Body 部分对 cypher 参数的说明已更新，同时添加了"不是 JSON 格式，是纯文本"的注意，这对用户理解 POST 请求格式很有帮助。
content/cn/docs/clients/restful-api/rebuild.md (2)
9-9: ✓ 标题格式调整无误。标题已正确添加空格分隔。
14-14: ✓ 路径迁移正确且一致。所有 REST API 端点已正确更新至新的 graphspace 作用域路径
/graphspaces/DEFAULT/graphs/hugegraph/...。PUT 请求路径（第 14、40、66 行）和对应的 GET 任务查询路径（第 33、59、85 行）保持一致，task_id 引用（1、2、3）也正确对应。Also applies to: 33-33, 40-40, 59-59, 66-66, 85-85
content/cn/docs/clients/restful-api/gremlin.md (3)
194-194: 确认异步 Gremlin 端点的路径迁移端点已正确迁移至
/graphspaces/DEFAULT/graphs/hugegraph/jobs/gremlin，符合新的图空间作用域路径结构。响应中的 task_id 可用于后续状态查询。请确认此端点与系统当前部署中的图空间配置一致。
231-231: 验证异步任务查询端点的路径一致性异步任务查询 URL 已正确更新为
/graphspaces/DEFAULT/graphs/hugegraph/tasks/{task_id}的新格式。请确认这与异步 Gremlin 提交端点（第 194 行）的图空间和图名称参数保持一致。此外，建议在本节中为用户提供更清晰的
task_id定义，以及对任务状态查询响应格式的说明。
14-16: 参数描述更新评审参数说明已增强，包括
bindings的详细说明（与 MySQL Prepared Statement 的功能类比）和aliases的新增说明。这些更改有助于用户理解。但建议检查是否与其他 RESTful API 文档的参数格式保持一致。基于 PR 的更宽泛范围，可参考现有的学习资料…
content/cn/docs/clients/restful-api/schema.md (1)
14-16: Schema端点路径已正确更新。endpoint路径的graphspaces前缀迁移已完成，示例URL和参数说明保持一致。
content/en/docs/clients/restful-api/task.md (1)
19-19: Task API端点路径已正确更新至graphspaces作用域。四个任务相关的endpoint（列表、详情、删除、取消）的路径前缀已完整迁移。
Also applies to: 53-53, 85-85, 113-113
content/cn/docs/clients/restful-api/task.md (1)
19-19: Task API中文文档的路径已与英文版本同步。四个异步任务相关端点的路径已正确迁移至graphspaces作用域。
Also applies to: 53-53, 85-85, 113-113
content/cn/docs/clients/restful-api/edgelabel.md (1)
9-20: 路径前缀迁移已完整，参数说明规范化已完成。EdgeLabel相关的5个endpoint路径都已正确更新至graphspaces作用域，同时补充了graphspace参数说明，增强了文档的完整性。
content/cn/docs/clients/restful-api/traverser.md (1)
215-215: Traverser API的路径迁移已全面完成。文档中多个traverser相关endpoint（K-out、K-neighbor、Same Neighbors、Shortest Path、Paths等）的路径前缀都已完整迁移至/graphspaces/DEFAULT/graphs/{graph}/traversers格式。大型文档中的路径更新一致且完整。
Also applies to: 289-289, 456-456, 534-534, 755-755, 799-799, 1104-1104, 1256-1256, 1484-1484, 1560-1560
content/cn/docs/clients/restful-api/edge.md (1)
81-81: Edge API路径已完整迁移至graphspaces作用域，参数说明已补充。所有edge相关操作的endpoint（创建、批量操作、更新、删除、查询等）路径前缀都已正确更新。添加的路径参数说明（graphspace、graph、id）提高了文档的完整性。
Also applies to: 144-144, 212-212, 275-275, 377-377, 452-452, 488-488, 540-540, 589-589, 635-635, 651-651
content/en/docs/clients/restful-api/gremlin.md (1)
191-191: 异步API端点路径正确迁移异步Gremlin执行和任务状态查询的端点已正确从
/graphs/hugegraph/迁移到/graphspaces/DEFAULT/graphs/hugegraph/，保持了文档的一致性。Also applies to: 227-227, 258-258
content/cn/docs/clients/restful-api/vertexlabel.md (1)
9-21: 路径迁移和参数说明完整VertexLabel API的路径迁移到
/graphspaces/DEFAULT/graphs/hugegraph/已完成，异步任务查询URL（第310行）也正确更新。文档格式和参数说明保持良好。content/en/docs/clients/restful-api/graphspace.md (1)
11-16: 前置条件完整且清晰Graphspace API的前置条件说明（11-16行）清楚地列举了HStore模式、HStore后端、PD使用、认证等要求。这为用户正确使用API提供了必要的背景信息。
content/cn/docs/clients/restful-api/graphs.md (1)
11-11: 标题级别问题（MD001）第11行的
#### 6.1.1应为##### 6.1.1，因为上级标题是### 6.1 Graphs，标题级别应该逐级递增。-#### 6.1.1 列出图空间中全部的图 +##### 6.1.1 列出图空间中全部的图Likely an incorrect or invalid review comment.
content/en/docs/clients/restful-api/auth.md (1)
1044-1200: 新增的 Graphspace Manager API 文档结构完整且清晰第 10.7 节新增的 Graphspace Manager API 提供了完整的图空间级别访问控制功能，包括检查角色、列出管理员、授予/撤销权限和查询角色等操作。API 设计遵循 RESTful 原则，与现有认证体系保持一致。
content/en/docs/clients/restful-api/graphs.md (1)
9-9: 新增的认证要求说明和版本兼容性说明清晰有益第 9 行新增的提醒准确说明了 HugeGraph 1.7.0 开始需要启用认证模式进行动态图创建，并提供了配置文件方式的参考链接。第 195 行的版本兼容性说明帮助用户理解旧版本的使用方式。这些更新提高了文档的完整性和易用性。
Also applies to: 195-195
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
.github/workflows/validate-release.yml (1)
108-108: 修复 CATEGORY_X 许可证验证规则的不一致性。第108行（源包验证）和第247行（二进制包验证）中的 CATEGORY_X 正则表达式存在不匹配：
- 第108行：以
JSON结尾（未转义）- 第247行：以
JSON\.org结尾（已转义）这导致对源包和二进制包的许可证验证逻辑不一致。第108行应同步更新为
JSON\.org，以确保两个验证步骤使用相同的许可证分类规则。应用以下修改来修复不一致性：
- CATEGORY_X="\bGPL|\bLGPL|Sleepycat License|BSD-4-Clause|\bBCL\b|JSR-275|Amazon Software License|\bRSAL\b|\bQPL\b|\bSSPL|\bCPOL|\bNPL1|Creative Commons Non-Commercial|JSON" + CATEGORY_X="\bGPL|\bLGPL|Sleepycat License|BSD-4-Clause|\bBCL\b|JSR-275|Amazon Software License|\bRSAL\b|\bQPL\b|\bSSPL|\bCPOL|\bNPL1|Creative Commons Non-Commercial|JSON\.org"Also applies to: 247-247
🧹 Nitpick comments (5)
content/en/docs/changelog/hugegraph-1.7.0-release-notes.md (3)
11-11: Add space in Java version reference.Line 11 should read
Java 11instead ofJava11for consistency with standard version formatting. This is a minor presentation issue.-For **1.7.0** version `hugegraph`, related components only support Java11. +For **1.7.0** version `hugegraph`, related components only support Java 11.
17-17: Add period to abbreviation "etc."The abbreviation "etc." should have a period at the end. Update line 17 from
c*(.etc)toc*(.etc.).-- **BREAKING CHANGE**: Disable legacy backends include MySQL/PG/c*(.etc) [#2746](https://github.com/apache/incubator-hugegraph/pull/2746) +- **BREAKING CHANGE**: Disable legacy backends include MySQL/PG/c*(.etc.) [#2746](https://github.com/apache/incubator-hugegraph/pull/2746)
119-119: Use hyphenation for compound adjective.Line 119 should use a hyphen to join the compound adjective. Change
task priority based schedulingtotask priority-based scheduling.-- Support task priority based scheduling [#336](https://github.com/apache/incubator-hugegraph-computer/pull/336) +- Support task priority-based scheduling [#336](https://github.com/apache/incubator-hugegraph-computer/pull/336)content/cn/docs/changelog/hugegraph-1.7.0-release-notes.md (2)
17-17: 添加缩写"etc."的句号。缩写词"etc."的末尾应添加句号。第 17 行应从
c*(.etc)更改为c*(.etc.)。-- **BREAKING CHANGE**: Disable legacy backends include MySQL/PG/c*(.etc) [#2746](https://github.com/apache/incubator-hugegraph/pull/2746) +- **BREAKING CHANGE**: Disable legacy backends include MySQL/PG/c*(.etc.) [#2746](https://github.com/apache/incubator-hugegraph/pull/2746)
119-119: 对复合形容词使用连字符。第 119 行应使用连字符连接复合形容词。将
task priority based scheduling更改为task priority-based scheduling。-- Support task priority based scheduling [#336](https://github.com/apache/incubator-hugegraph-computer/pull/336) +- Support task priority-based scheduling [#336](https://github.com/apache/incubator-hugegraph-computer/pull/336)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (13)
.github/workflows/validate-release.yml(2 hunks)content/cn/docs/changelog/hugegraph-1.7.0-release-notes.md(1 hunks)content/cn/docs/quickstart/computing/_index.md(1 hunks)content/cn/docs/quickstart/computing/hugegraph-vermeer.md(3 hunks)content/cn/docs/quickstart/hugegraph-ai/_index.md(1 hunks)content/cn/docs/quickstart/hugegraph/_index.md(1 hunks)content/cn/docs/quickstart/toolchain/_index.md(1 hunks)content/en/docs/changelog/hugegraph-1.7.0-release-notes.md(1 hunks)content/en/docs/quickstart/computing/_index.md(1 hunks)content/en/docs/quickstart/computing/hugegraph-vermeer.md(3 hunks)content/en/docs/quickstart/hugegraph-ai/_index.md(1 hunks)content/en/docs/quickstart/hugegraph/_index.md(1 hunks)content/en/docs/quickstart/toolchain/_index.md(1 hunks)
✅ Files skipped from review due to trivial changes (3)
- content/cn/docs/quickstart/hugegraph/_index.md
- content/en/docs/quickstart/hugegraph-ai/_index.md
- content/cn/docs/quickstart/computing/_index.md
🧰 Additional context used
🪛 LanguageTool
content/cn/docs/changelog/hugegraph-1.7.0-release-notes.md
[style] ~17-~17: In American English, abbreviations like “etc.” require a period.
Context: ...le legacy backends include MySQL/PG/c*(.etc) [#2746](https://github.com/apache/incu...
(ETC_PERIOD)
[grammar] ~119-~119: Use a hyphen to join words.
Context: ...mputer/pull/332) - Support task priority based scheduling [apache#336](https://github.c...
(QB_NEW_EN_HYPHEN)
[style] ~152-~152: ‘vid’ is informal. Consider replacing it.
Context: ...hugegraph-ai/pull/122) - Timely execute vid embedding & enhance some HTTP logic [#1...
(VID)
[style] ~160-~160: ‘vid’ is informal. Consider replacing it.
Context: ...cubator-hugegraph-ai/pull/159) - Change vid embedding x:yy to yy & use multi-thread...
(VID)
[style] ~169-~169: ‘vid’ is informal. Consider replacing it.
Context: ...ubator-hugegraph-ai/pull/187) - Replace vid by full vertexes info [apache#189](https://gi...
(VID)
[style] ~175-~175: ‘vid’ is informal. Consider replacing it.
Context: ... Support graph checking before updating vid embedding [apache#205](https://github.com/apa...
(VID)
[style] ~212-~212: ‘vid’ is informal. Consider replacing it.
Context: ...ncubator-hugegraph-ai/pull/131) - Multi vid k-neighbor query only return the data o...
(VID)
[style] ~212-~212: ‘vid’ is informal. Consider replacing it.
Context: ...bor query only return the data of first vid [apache#132](https://github.com/apache/incuba...
(VID)
[style] ~224-~224: ‘vid’ is informal. Consider replacing it.
Context: ... Failed to remove vectors when updating vid embedding [apache#243](https://github.com/apa...
(VID)
content/en/docs/changelog/hugegraph-1.7.0-release-notes.md
[grammar] ~11-~11: Ensure spelling is correct
Context: ...graph`, related components only support Java11. ### hugegraph #### API Changes - **...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[style] ~17-~17: In American English, abbreviations like “etc.” require a period.
Context: ...le legacy backends include MySQL/PG/c*(.etc) [#2746](https://github.com/apache/incu...
(ETC_PERIOD)
[grammar] ~119-~119: Use a hyphen to join words.
Context: ...mputer/pull/332) - Support task priority based scheduling [apache#336](https://github.c...
(QB_NEW_EN_HYPHEN)
[style] ~152-~152: ‘vid’ is informal. Consider replacing it.
Context: ...hugegraph-ai/pull/122) - Timely execute vid embedding & enhance some HTTP logic [#1...
(VID)
[style] ~160-~160: ‘vid’ is informal. Consider replacing it.
Context: ...cubator-hugegraph-ai/pull/159) - Change vid embedding x:yy to yy & use multi-thread...
(VID)
[style] ~169-~169: ‘vid’ is informal. Consider replacing it.
Context: ...ubator-hugegraph-ai/pull/187) - Replace vid by full vertexes info [apache#189](https://gi...
(VID)
[style] ~175-~175: ‘vid’ is informal. Consider replacing it.
Context: ... Support graph checking before updating vid embedding [apache#205](https://github.com/apa...
(VID)
[style] ~212-~212: ‘vid’ is informal. Consider replacing it.
Context: ...ncubator-hugegraph-ai/pull/131) - Multi vid k-neighbor query only return the data o...
(VID)
[style] ~212-~212: ‘vid’ is informal. Consider replacing it.
Context: ...bor query only return the data of first vid [apache#132](https://github.com/apache/incuba...
(VID)
[style] ~224-~224: ‘vid’ is informal. Consider replacing it.
Context: ... Failed to remove vectors when updating vid embedding [apache#243](https://github.com/apa...
(VID)
🪛 markdownlint-cli2 (0.18.1)
content/cn/docs/quickstart/computing/hugegraph-vermeer.md
160-160: Bare URL used
(MD034, no-bare-urls)
content/en/docs/quickstart/computing/hugegraph-vermeer.md
161-161: Bare URL used
(MD034, no-bare-urls)
🔇 Additional comments (10)
.github/workflows/validate-release.yml (1)
13-13: 认可 gpg_user 默认值的更新。从人类可读的全名改为 GPG 用户标识符（'pengjunzhi'）是恰当的，因为第86行和90行中的
gpg --edit-key $USER命令期望接收密钥ID或用户标识符而非全名。content/en/docs/quickstart/toolchain/_index.md (1)
8-13: 清晰且一致的最佳实践指导。 新增的 DeepWiki 最佳实践部分与其他快速入门模块保持一致，文案清晰，能有效引导用户访问更新的文档资源。content/en/docs/quickstart/hugegraph/_index.md (1)
7-11: 保持一致的文档推荐模式。 此部分与其他快速入门页面的 DeepWiki 推荐保持一致，有助于统一引导用户至更新的资源。content/en/docs/quickstart/computing/_index.md (1)
7-11: 保持全局一致性。 DeepWiki 最佳实践部分与其他快速入门模块保持一致，强化了对实时文档资源的推荐。content/cn/docs/quickstart/toolchain/_index.md (1)
9-14: 中英文文档保持一致。 中文版本与英文版本的 DeepWiki 最佳实践部分保持对齐，翻译准确，表述清晰。content/cn/docs/quickstart/hugegraph-ai/_index.md (1)
10-14: 适当的位置和一致的内容。 最佳实践部分放在核心功能之前，能够更好地引导读者。翻译和格式与其他模块保持一致。content/cn/docs/quickstart/computing/hugegraph-vermeer.md (2)
19-75: 部署方案详尽且实用。 Docker Compose 方案提供了完整的配置示例和清晰的修改指南，对用户很有帮助。
156-179: 数据加载示例清晰。 提供三种加载方式（本地、HugeGraph、HDFS）的完整示例，覆盖了常见使用场景。安全警告（第 184 行）恰当地提醒用户避免在代码中存储真实密码。content/en/docs/quickstart/computing/hugegraph-vermeer.md (2)
19-75: 详尽的 Docker Compose 部署指南。 提供完整的配置示例、修改说明和启动/停止指令，便于用户快速上手。
157-230: 三种数据加载方式的完整覆盖。 文档清晰地展示了本地加载、HugeGraph 加载和 HDFS 加载的详细示例。第 185 行的安全警告恰当地提醒用户不要在代码或配置中存储真实密码。
|
|
||
| - Filter dynamice path(PUT/GET/DELETE) with params cause OOM [#2569](https://github.com/apache/incubator-hugegraph/pull/2569) | ||
| - JRaft Histogram Metrics Value NaN [#2631](https://github.com/apache/incubator-hugegraph/pull/2631) | ||
| - Update server image desc [#2702](https://github.com/apache/incubator-hugegraph/pull/2702) |
There was a problem hiding this comment.
此 Release Notes 文件包含 WIP/BETA 标记，表明文档尚未完成。建议：
- 在正式发布前移除 WIP 标记
- 确认所有 PR 链接和描述的准确性
- 考虑添加贡献者致谢部分
此外注意到 Bug Fixes 中有一处拼写错误：
dynamice应改为dynamic
| - Update server image desc [#2702](https://github.com/apache/incubator-hugegraph/pull/2702) | |
| - Filter dynamic path(PUT/GET/DELETE) with params cause OOM [#2569](https://github.com/apache/incubator-hugegraph/pull/2569) |
| -v ${CONFIG_DIR}:/go/bin/config \ | ||
| hugegraph/vermeer \ | ||
| --env=worker | ||
| ``` |
There was a problem hiding this comment.
🧹 安全最佳实践
这里的安全警告很好！但建议将其移到示例 JSON 之前，让用户在看到示例代码前就注意到安全提示。另外可以考虑添加具体的环境变量使用示例：
| ``` | |
| 2. 从hugegraph加载 | |
| ⚠️ **安全警告**：切勿在配置文件或代码中存储真实密码。请改用环境变量或安全的凭据管理系统。 | |
| **request 示例：** |
|
|
||
| ``` | ||
| DELETE http://localhost:8080/graphs/hugegraph/auth/groups/-69:grant | ||
| DELETE http://localhost:8080/graphspaces/DEFAULT/auth/groups/-69:grant |
There was a problem hiding this comment.
在 auth API 的 Group 和 Target 相关操作中，某些 API 仍然使用旧的 ID 格式（如 -69:grant、-77:gremlin），但 User API 已切换为新格式（直接使用用户名如 test、admin）。
建议确认：
- Group/Target API 是否也应该使用简化的 ID 格式？
- 如果不同实体确实使用不同格式，应在文档中明确说明
例如对比：
- User:
DELETE .../auth/users/test✅ 简化格式 - Group:
DELETE .../auth/groups/-69:grant❓ 仍使用旧格式
| ``` | ||
|
|
||
| 如果配置多个 HugeGraph-Server 节点，需要为每个节点修改 `rest-server.properties` 配置文件，例如： | ||
|
|
There was a problem hiding this comment.
🧹 配置完整性
分布式存储配置说明很清晰。建议补充：
- 是否需要在
gremlin-server.yaml中也进行相应配置？ - 多节点部署时，是否需要配置负载均衡器？
- 建议添加节点健康检查的说明
There was a problem hiding this comment.
Actionable comments posted: 12
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (12)
content/en/docs/clients/restful-api/propertykey.md (1)
1-5: 在前置内容中添加description字段。根据编码指南，所有文档文件的前置内容应包含 title、weight 和 description 字段。当前文件缺少
description字段。建议添加 description 字段，例如：
--- title: "PropertyKey API" linkTitle: "PropertyKey" weight: 2 +description: > + PropertyKey API documentation for HugeGraph ---content/cn/docs/clients/restful-api/propertykey.md (1)
1-5: 前置元数据缺少 description 字段。根据编码指南，
content/**/*.md文件应包含 front matter，其中包括 title、weight 和 description。当前文件缺少 description 字段。建议添加 description 字段。示例修改如下：
--- title: "PropertyKey API" linkTitle: "PropertyKey" weight: 2 +description: "PropertyKey schema API documentation" ---content/cn/docs/clients/restful-api/rank.md (2)
1-5: 前置元数据缺少 description 字段按照编码指南要求，文档前置元数据需包含 title、weight 和 description。当前缺少 description 字段，建议补充该字段以提供文档概览。
示例修复：
--- title: "Rank API" linkTitle: "Rank" weight: 10 +description: "Rank API documentation for HugeGraph, including Personal Rank and Neighbor Rank algorithms" ---
31-31: 代码块缺少语言标识Groovy 代码块缺少语言标识，应在开头三个反引号后指定
groovy，以启用正确的语法高亮显示。修复如下：
-``` +```groovy //////////////////////////////////////////////////////////// // UserID::Gender::Age::Occupation::Zip-codecontent/en/docs/clients/restful-api/traverser.md (2)
1-5: Front matter缺少description字段请在front matter中补充description，便于站点生成摘要与SEO。
--- title: "Traverser API" linkTitle: "Traverser" weight: 9 +description: "HugeGraph Traverser REST APIs with examples (k-out/k-neighbor/paths/shortest path/etc.) using graphspaces." ---
218-221: 大量URL仍为旧路径/graphs/{graph}，与graphspaces改造不一致上述行的“Method & Url”仍使用/graphs/{graph}/...，应统一切换为/graphspaces/{graphspace}/graphs/{graph}/...（示例可用DEFAULT）。否则会误导升级用户。
示例修正（其余同理替换基路径）：
-GET http://localhost:8080/graphs/{graph}/traversers/kout?source="1:marko"&max_depth=2 +GET http://localhost:8080/graphspaces/DEFAULT/graphs/{graph}/traversers/kout?source="1:marko"&max_depth=2并为所有“Method & Url”代码块加语言标识http、为JSON体加json，以满足MD040。
Also applies to: 292-295, 459-462, 761-763, 805-807, 851-853, 911-913, 961-963, 1025-1027, 1109-1112, 1489-1492, 1564-1567, 1663-1666, 1854-1857, 2018-2021, 2088-2091, 2259-2261, 2328-2331
content/cn/docs/clients/restful-api/traverser.md (1)
1-5: Front matter缺少description字段为统一站点规范，请补充description。
--- title: "Traverser API" linkTitle: "Traverser" weight: 9 +description: "HugeGraph 遍历（Traverser）REST 接口：k-out/k-neighbor/路径/最短路等示例与参数说明，基于graphspaces。" ---content/en/docs/clients/restful-api/vertex.md (1)
1-5: Front matter缺少description字段请补充description以便生成器与SEO使用。
--- title: "Vertex API" linkTitle: "Vertex" weight: 7 +description: "REST APIs for HugeGraph vertices: create, batch, update strategies, query, pagination, and delete using graphspaces." ---content/en/docs/clients/restful-api/edge.md (1)
1-5: Front matter缺少description字段请补充description。
--- title: "Edge API" linkTitle: "Edge" weight: 8 +description: "REST APIs for HugeGraph edges: create, batch, update strategies, query, pagination, and delete under graphspaces." ---content/en/docs/clients/restful-api/_index.md (1)
1-5: Front matter缺少description字段请添加简短描述，概述REST入口与版本兼容提示。
--- title: "HugeGraph RESTful API" linkTitle: "RESTful API" weight: 1 +description: "Entry to HugeGraph REST docs with version compatibility, graphspaces paths, and links to detailed modules." ---content/en/docs/clients/restful-api/edgelabel.md (1)
1-5: Front matter缺少description字段补充描述有助于索引与概览。
--- title: "EdgeLabel API" linkTitle: "EdgeLabel" weight: 4 +description: "REST APIs to manage EdgeLabel: create, mutate (append/eliminate), list, get and delete, with TTL settings." ---content/cn/docs/clients/restful-api/gremlin.md (1)
1-5: Front matter缺少description字段请补充描述。
--- title: "Gremlin API" linkTitle: "Gremlin" weight: 14 +description: "HugeGraph Gremlin 同步与异步执行接口，包含参数、别名用法、任务查询示例，基于graphspaces。" ---
♻️ Duplicate comments (4)
content/cn/docs/clients/restful-api/graphspace.md (2)
71-94: 创建示例请求/响应不一致（memory_limit、storage_limit等）请求体中 memory_limit=8192、storage_limit=1000000，响应体却展示 memory_limit=1024、storage_limit=1000，容易误导用户。请保持与请求一致，或在响应示例上方明确“服务端会归一化/覆盖哪些字段及原因”。
"cpu_limit": 1000, - "memory_limit": 1024, - "storage_limit": 1000, + "memory_limit": 8192, + "storage_limit": 1000000,
233-258: 更新示例的响应未反映更新后的值请求将 memory_limit/storage_limit/max_graph_number/max_role_number 更新为更大值，但响应仍为旧值。HTTP 200 示例应展示更新后的最终状态。
"cpu_limit": 2000, - "memory_limit": 1024, - "storage_limit": 1000, + "memory_limit": 40960, + "storage_limit": 2048, "operator_image_path": "127.0.0.1/hugegraph-registry/hugegraph-computer-operator:3.1.1", "internal_algorithm_image_url": "127.0.0.1/hugegraph-registry/hugegraph-computer-algorithm:3.1.1", "compute_cpu_limit": 0, "compute_memory_limit": 0, - "max_graph_number": 100, - "max_role_number": 10, + "max_graph_number": 1000, + "max_role_number": 100,如确有服务端归一化逻辑，请在文内以Note说明。
content/cn/docs/clients/restful-api/edgelabel.md (1)
26-26: 修复代码块语言标识（重复问题）根据 markdownlint 规则，多个 Method & Url 代码块缺少语言标识。这个问题在之前的审查中已被标记，但仍未修复。建议添加 bash 标识：
-``` +```bash POST http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/schema/edgelabels -``` +```bash受影响的行：26、136、189、251、293
注意：这与之前的评论 (coderabbitai[bot] 在前面的审查中标记过) 重复，建议一次性修复所有代码块。
Also applies to: 136-136, 189-189, 251-251, 293-293
content/cn/docs/clients/restful-api/graphs.md (1)
194-201: 修复 Response Body 中的 JSON 格式错误第 196-198 行中，
"name"字段被不规范地分成多行显示，这违反了 JSON 格式规范。应该将其合并为单行的键值对。应用以下修改：
##### Response Body ```javascript { - "name" -: - "hugegraph2", + "name": "hugegraph2", "backend": "rocksdb" }</blockquote></details> </blockquote></details> <details> <summary>🧹 Nitpick comments (15)</summary><blockquote> <details> <summary>content/en/docs/clients/restful-api/indexlabel.md (1)</summary><blockquote> `1-5`: **前置元数据缺少 description 字段。** 根据编码指南，文档文件的前置元数据应包含 title、weight 和 description。当前文件缺少 description 字段。请添加 description 字段以完整化文件的前置元数据。 建议添加 description 字段： ```diff --- title: "IndexLabel API" linkTitle: "IndexLabel" weight: 5 +description: > + IndexLabel API for creating and managing index labels in HugeGraph ---content/cn/docs/clients/restful-api/indexlabel.md (1)
1-5: 前置事项缺少 description 字段。根据编码规范，所有文档文件应在前置事项中包含 title、weight 和 description 字段。请添加 description 字段以完整描述本文档内容。
--- title: "IndexLabel API" linkTitle: "IndexLabel" weight: 5 + description: "索引标签 RESTful API 的详细说明和使用示例" ---content/en/docs/clients/restful-api/traverser.md (1)
57-59: 重复小节标题本文件已存在两处“3.2 Detailed Explanation of Traverser API”，影响目录与导航。
建议将第二处标题更名为“3.3 Examples”或合并内容，避免重复标题（MD024）。
content/cn/docs/clients/restful-api/traverser.md (1)
214-216: 为代码块补充语言标识并替换硬Tab大量“Method & Url/Response Body/Request Body”代码块缺少语言标识（MD040），且列表中存在硬Tab（MD010）与不一致缩进（MD007）。
- URL块使用http；请求/响应体使用json；Shell示例使用shell。
- 将列表项的制表符替换为2或4空格，并统一同级缩进。
示例：-``` +```http GET http://localhost:8080/graphspaces/DEFAULT/graphs/{graph}/traversers/kout?source="1:marko"&max_depth=2 -``` +```Also applies to: 288-290, 533-536, 754-756, 844-846, 904-906, 1018-1021, 1103-1106, 1255-1257, 1483-1486, 1559-1562, 1658-1661, 1847-1850, 2011-2013, 2080-2083, 2250-2253, 2319-2321, 2406-2409, 2513-2516, 2645-2647, 2829-2832, 2941-2944
content/en/docs/clients/restful-api/vertex.md (1)
48-50: 为代码块补充语言标识为HTTP与Shell示例添加语言（MD040）。
-``` +```http POST http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/graph/vertices -``` +``` -```shell +```shell curl -H "Content-Type: application/json" -d '[...]' http://127.0.0.1:8080/graphspaces/DEFAULT/graphs/hugegraph/graph/vertices/batchAlso applies to: 88-90, 133-135, 229-231, 394-396, 426-427, 432-434, 493-495, 549-551, 583-585 </blockquote></details> <details> <summary>content/en/docs/clients/restful-api/edge.md (1)</summary><blockquote> `79-82`: **为HTTP示例代码块添加语言** 补充http语言标识，提升可读性并通过MD040。 ```diff -``` +```http PUT http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/graph/edges/S1:marko>2>>S2:lop?action=append -``` +```Also applies to: 142-144, 209-211, 271-273, 372-374, 446-448, 482-484, 582-584, 627-629
content/cn/docs/clients/restful-api/graphspace.md (2)
22-24: 为HTTP方法代码块添加语言标识为所有“Method & Url”代码块指定http，以通过MD040并提升可读性。
-``` +```http POST http://localhost:8080/graphspaces -``` +```Also applies to: 100-102, 131-133, 202-204, 270-272
11-17: 前置条件中的鉴权默认密码提示需更明确“默认账密为 admin:pa”表述过于简略。建议写明“默认用户名/密码”，并强调生产环境务必修改。若版本差异存在默认值变化，请在此备注版本范围。
content/cn/docs/clients/restful-api/gremlin.md (2)
132-136: blockquote中含空行，影响渲染（MD028）请移除空白行，保持引文连续。
> 为图和遍历器添加别名后使用别名操作。其中，`hugegraph`是原生存在的变量，`__g_hugegraph`是`HugeGraphServer`额外添加的变量， - > 每个图都会存在一个对应的这样格式（__g_${graph}）的遍历器对象。
194-196: 为HTTP示例添加语言标识为“Method & Url”与任务查询示例补充http语言标识。
-``` +```http POST http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/jobs/gremlin -``` +```Also applies to: 231-233, 262-262
content/en/docs/clients/restful-api/graphspace.md (1)
11-11: 将强调改为标题格式根据 markdownlint 规则，以下行使用了强调（粗体）而应使用标题格式：
- 第 11 行：
**Prerequisites**应改为### Prerequisites或适当的标题级别- 第 125 行：
**Path parameters**- 第 174 行：
**Path parameter**- 第 178 行：
**Request parameters**建议改为标准标题格式以提高可读性和文档结构清晰度。
Also applies to: 125-125, 174-174, 178-178
content/cn/docs/clients/restful-api/vertex.md (1)
433-433: 将强调改为标题格式根据 markdownlint 规则（MD036），以下行使用了强调而应使用标题格式：
- 第 433 行：
**查询所有 age 为 29 且 label 为 person 的顶点**- 第 465 行：
**分页查询所有顶点，获取第一页...**- 第 532 行：
**分页查询所有顶点，获取下一页...**- 第 638 行：
**仅根据 Id 删除顶点**- 第 652 行：
**根据 Label+Id 删除顶点**建议改为合适的标题级别（如
####或#####）。Also applies to: 465-465, 532-532, 638-638, 652-652
content/en/docs/clients/restful-api/auth.md (1)
930-931: 改进文本位置和格式部分文本注释（如第 930-931 行的"Authorization can only be modified..."）放在了 Params 之后，与其他操作文档的结构不一致。建议将此说明移到 Params 之前，以保持文档结构的一致性。
Also applies to: 945-946, 961-962
content/cn/docs/clients/restful-api/edge.md (1)
244-246: shell 命令示例需要语言标识第 245 行的 curl 命令块应标记为 bash 或 shell：
-```shell +```bash curl -H "Content-Type: application/json" -d '[...]' -``` +```bashcontent/cn/docs/clients/restful-api/graphs.md (1)
9-9: 整合版本兼容性说明文档文档中现在分散着多处关于版本特定行为的说明：
- 第 9 行：1.7.0+ 版本动态创建图需要开启鉴权
- 第 120 行：克隆图操作使用 JSON 格式的说明
- 第 231 行：1.5.0 及之前版本使用 text/plain 格式的说明
建议在文档开头（如 6.2 节开头）统一添加一份版本兼容性说明表格或清晰的备注，说明各版本之间的行为差异（特别是请求体格式从 text/plain 到 JSON 的变化），以便用户快速了解其版本适用情况。
Also applies to: 120-120, 231-231
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (37)
content/cn/docs/clients/restful-api/_index.md(1 hunks)content/cn/docs/clients/restful-api/auth.md(36 hunks)content/cn/docs/clients/restful-api/cypher.md(2 hunks)content/cn/docs/clients/restful-api/edge.md(18 hunks)content/cn/docs/clients/restful-api/edgelabel.md(7 hunks)content/cn/docs/clients/restful-api/graphs.md(15 hunks)content/cn/docs/clients/restful-api/graphspace.md(1 hunks)content/cn/docs/clients/restful-api/gremlin.md(7 hunks)content/cn/docs/clients/restful-api/indexlabel.md(5 hunks)content/cn/docs/clients/restful-api/propertykey.md(5 hunks)content/cn/docs/clients/restful-api/rank.md(4 hunks)content/cn/docs/clients/restful-api/rebuild.md(4 hunks)content/cn/docs/clients/restful-api/schema.md(2 hunks)content/cn/docs/clients/restful-api/task.md(4 hunks)content/cn/docs/clients/restful-api/traverser.md(40 hunks)content/cn/docs/clients/restful-api/variable.md(4 hunks)content/cn/docs/clients/restful-api/vertex.md(14 hunks)content/cn/docs/clients/restful-api/vertexlabel.md(7 hunks)content/cn/docs/quickstart/hugegraph/hugegraph-server.md(4 hunks)content/en/docs/clients/restful-api/_index.md(1 hunks)content/en/docs/clients/restful-api/auth.md(40 hunks)content/en/docs/clients/restful-api/edge.md(11 hunks)content/en/docs/clients/restful-api/edgelabel.md(6 hunks)content/en/docs/clients/restful-api/graphs.md(14 hunks)content/en/docs/clients/restful-api/graphspace.md(1 hunks)content/en/docs/clients/restful-api/gremlin.md(3 hunks)content/en/docs/clients/restful-api/indexlabel.md(5 hunks)content/en/docs/clients/restful-api/propertykey.md(5 hunks)content/en/docs/clients/restful-api/rank.md(2 hunks)content/en/docs/clients/restful-api/rebuild.md(4 hunks)content/en/docs/clients/restful-api/schema.md(1 hunks)content/en/docs/clients/restful-api/task.md(4 hunks)content/en/docs/clients/restful-api/traverser.md(7 hunks)content/en/docs/clients/restful-api/variable.md(4 hunks)content/en/docs/clients/restful-api/vertex.md(11 hunks)content/en/docs/clients/restful-api/vertexlabel.md(6 hunks)content/en/docs/quickstart/hugegraph/hugegraph-server.md(6 hunks)
🚧 Files skipped from review as they are similar to previous changes (15)
- content/cn/docs/clients/restful-api/rebuild.md
- content/en/docs/clients/restful-api/schema.md
- content/en/docs/clients/restful-api/task.md
- content/en/docs/clients/restful-api/variable.md
- content/cn/docs/quickstart/hugegraph/hugegraph-server.md
- content/cn/docs/clients/restful-api/schema.md
- content/cn/docs/clients/restful-api/task.md
- content/cn/docs/clients/restful-api/cypher.md
- content/en/docs/clients/restful-api/rebuild.md
- content/en/docs/clients/restful-api/vertexlabel.md
- content/cn/docs/clients/restful-api/_index.md
- content/cn/docs/clients/restful-api/variable.md
- content/en/docs/clients/restful-api/gremlin.md
- content/en/docs/quickstart/hugegraph/hugegraph-server.md
- content/en/docs/clients/restful-api/rank.md
🧰 Additional context used
📓 Path-based instructions (1)
content/**/*.md
📄 CodeRabbit inference engine (AGENTS.md)
Include front matter (title, weight, description) in all documentation files
Files:
content/en/docs/clients/restful-api/edge.mdcontent/cn/docs/clients/restful-api/edgelabel.mdcontent/en/docs/clients/restful-api/edgelabel.mdcontent/cn/docs/clients/restful-api/graphs.mdcontent/en/docs/clients/restful-api/_index.mdcontent/en/docs/clients/restful-api/graphs.mdcontent/cn/docs/clients/restful-api/auth.mdcontent/cn/docs/clients/restful-api/edge.mdcontent/cn/docs/clients/restful-api/gremlin.mdcontent/en/docs/clients/restful-api/auth.mdcontent/en/docs/clients/restful-api/indexlabel.mdcontent/cn/docs/clients/restful-api/traverser.mdcontent/cn/docs/clients/restful-api/vertexlabel.mdcontent/en/docs/clients/restful-api/propertykey.mdcontent/en/docs/clients/restful-api/traverser.mdcontent/cn/docs/clients/restful-api/graphspace.mdcontent/cn/docs/clients/restful-api/indexlabel.mdcontent/cn/docs/clients/restful-api/propertykey.mdcontent/cn/docs/clients/restful-api/rank.mdcontent/cn/docs/clients/restful-api/vertex.mdcontent/en/docs/clients/restful-api/graphspace.mdcontent/en/docs/clients/restful-api/vertex.md
🪛 LanguageTool
content/cn/docs/clients/restful-api/traverser.md
[uncategorized] ~13-~13: 您的意思是“"不"可”？
Context: ...rser API 包括： - K-out API，根据起始顶点，查找恰好 N 步可达的邻居，分为基础版和高级版： - 基础版使用 GET 方法，根据起始...
(BU)
[uncategorized] ~14-~14: 您的意思是“"不"可”？
Context: ...版和高级版： - 基础版使用 GET 方法，根据起始顶点，查找恰好 N 步可达的邻居 - 高级版使用 POST 方法，根据起始顶点，查找恰好 N ...
(BU)
[uncategorized] ~15-~15: 您的意思是“"不"可”？
Context: ...可达的邻居 - 高级版使用 POST 方法，根据起始顶点，查找恰好 N 步可达的邻居，与基础版的不同在于： - 支持只统计邻居数量 ...
(BU)
[uncategorized] ~19-~19: 您的意思是“"不"以内”？
Context: ...回到达邻居的最短路径 - K-neighbor API，根据起始顶点，查找 N 步以内可达的所有邻居，分为基础版和高级版： - 基础版使用 GET 方法，...
(BU)
[uncategorized] ~20-~20: 您的意思是“"不"以内”？
Context: ...基础版和高级版： - 基础版使用 GET 方法，根据起始顶点，查找 N 步以内可达的所有邻居 - 高级版使用 POST 方法，根据起始顶点，查找 ...
(BU)
[uncategorized] ~21-~21: 您的意思是“"不"以内”？
Context: ...可达的所有邻居 - 高级版使用 POST 方法，根据起始顶点，查找 N 步以内可达的所有邻居，与基础版的不同在于： - 支持只统计邻居数量...
(BU)
[uncategorized] ~197-~197: 您的意思是“"不"可”？
Context: ...、方向、边的类型（可选）和深度 depth，查找从起始顶点出发恰好 depth 步可达的顶点 ###### Params - source：起始顶点 id，必...
(BU)
[uncategorized] ~237-~237: 您的意思是“"不"关系”？
Context: ... ] } ``` ##### 3.2.1.3 适用场景 查找恰好 N 步关系可达的顶点。两个例子： - 家族关系中，查找一个人的所有孙子，person...
(BU)
[uncategorized] ~246-~246: 您的意思是“"不"可”？
Context: ...方向、边类型和过滤属性）和深度 depth，查找从起始顶点出发恰好 depth 步可达的顶点。 > 与 K-out 基础版的不同在于： > - 支持只统计邻居数...
(BU)
[uncategorized] ~438-~438: 您的意思是“"不"之内”？
Context: ...点、方向、边的类型（可选）和深度 depth，查找包括起始顶点在内、depth 步之内可达的所有顶点 > 相当于：起始顶点、K-out(1)、K-out(2)、...
(BU)
[uncategorized] ~482-~482: 您的意思是“"不"以内”？
Context: ..." ] } ``` ##### 3.2.3.3 适用场景 查找 N 步以内可达的所有顶点，例如： - 家族关系中，查找一个人五服以内所有子孙，per...
(BU)
[uncategorized] ~492-~492: 您的意思是“"不"内”？
Context: ...包括方向、边类型和过滤属性）和深度 depth，查找从起始顶点出发 depth 步内可达的所有顶点。 > 与 K-neighbor 基础版的不同在于： > - ...
(BU)
[uncategorized] ~1649-~1649: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：重"地"降
Context: ...- INCR 表示按照路径权重的升序排序 - DECR 表示按照路径权重的降序排序 - capacity：遍历过程中最大的访问的顶点数目，选填项，默认为 ...
(wb4)
content/cn/docs/clients/restful-api/rank.md
[uncategorized] ~127-~127: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：共同"地"打分
Context: ...如果决定向外游走，那么会选取某一个类型的出边，例如 rating 来查找共同的打分人： 1. 那就从当前节点的邻居节点中按照均匀分布随机选择一个，并且按...
(wb4)
content/en/docs/clients/restful-api/graphspace.md
[style] ~280-~280: Replacing this phrase with a shorter alternative might make your text sound more refined.
Context: ... graphspace releases all resources that belong to it.
(BELONG_TO_PRP)
🪛 markdownlint-cli2 (0.18.1)
content/cn/docs/clients/restful-api/edgelabel.md
26-26: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
188-188: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
250-250: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
293-293: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/cn/docs/clients/restful-api/traverser.md
14-14: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
15-15: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
16-16: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
17-17: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
18-18: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
20-20: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
21-21: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
22-22: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
23-23: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
24-24: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
27-27: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
28-28: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
35-35: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
36-36: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
45-45: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
46-46: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
46-46: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
46-46: Hard tabs
Column: 1
(MD010, no-hard-tabs)
47-47: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
47-47: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
47-47: Hard tabs
Column: 1
(MD010, no-hard-tabs)
49-49: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
50-50: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
50-50: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
50-50: Hard tabs
Column: 1
(MD010, no-hard-tabs)
51-51: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
51-51: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
51-51: Hard tabs
Column: 1
(MD010, no-hard-tabs)
214-214: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
257-257: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
258-258: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
259-259: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
260-260: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
261-261: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
262-262: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
263-263: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
264-264: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
265-265: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
271-271: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
272-272: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
273-273: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
274-274: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
276-276: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
277-277: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
278-278: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
279-279: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
288-288: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
455-455: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
503-503: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
504-504: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
505-505: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
506-506: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
507-507: Unordered list indentation
Expected: 6; Actual: 12
(MD007, ul-indent)
508-508: Unordered list indentation
Expected: 6; Actual: 12
(MD007, ul-indent)
509-509: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
510-510: Unordered list indentation
Expected: 6; Actual: 12
(MD007, ul-indent)
511-511: Unordered list indentation
Expected: 6; Actual: 12
(MD007, ul-indent)
512-512: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
513-513: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
518-518: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
519-519: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
520-520: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
521-521: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
523-523: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
524-524: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
525-525: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
526-526: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
533-533: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
754-754: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
798-798: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
832-832: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
833-833: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
833-833: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
833-833: Hard tabs
Column: 1
(MD010, no-hard-tabs)
834-834: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
834-834: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
834-834: Hard tabs
Column: 1
(MD010, no-hard-tabs)
835-835: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
836-836: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
844-844: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
904-904: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
954-954: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1018-1018: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1103-1103: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1236-1236: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1237-1237: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1238-1238: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
1238-1238: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1239-1239: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
1239-1239: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1242-1242: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1243-1243: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
1243-1243: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
1243-1243: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1244-1244: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
1244-1244: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
1244-1244: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1245-1245: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1246-1246: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1255-1255: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1483-1483: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1531-1531: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1532-1532: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1533-1533: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
1533-1533: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1534-1534: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
1534-1534: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1537-1537: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1538-1538: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1539-1539: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
1539-1539: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1540-1540: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
1540-1540: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1543-1543: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1544-1544: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
1544-1544: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
1544-1544: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1545-1545: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
1545-1545: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
1545-1545: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1546-1546: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1547-1547: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1559-1559: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1633-1633: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1634-1634: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1635-1635: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
1635-1635: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1636-1636: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
1636-1636: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1639-1639: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1640-1640: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
1640-1640: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
1640-1640: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1641-1641: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
1641-1641: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
1641-1641: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1642-1642: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1643-1643: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1644-1644: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1645-1645: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1647-1647: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1648-1648: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1649-1649: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1658-1658: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1820-1820: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1821-1821: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1822-1822: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
1822-1822: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1823-1823: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
1823-1823: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1826-1826: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1827-1827: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1828-1828: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
1828-1828: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1829-1829: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
1829-1829: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1832-1832: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1833-1833: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
1833-1833: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
1833-1833: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1834-1834: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
1834-1834: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
1834-1834: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1835-1835: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1836-1836: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1837-1837: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1847-1847: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
2011-2011: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
2054-2054: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
2055-2055: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
2056-2056: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
2056-2056: Hard tabs
Column: 1
(MD010, no-hard-tabs)
2057-2057: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
2057-2057: Hard tabs
Column: 1
(MD010, no-hard-tabs)
2061-2061: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
2062-2062: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
2063-2063: Inconsistent indentation for list items at the same level
Expected: 8; Actual: 2
(MD005, list-indent)
2063-2063: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
2063-2063: Hard tabs
Column: 1
(MD010, no-hard-tabs)
2064-2064: Inconsistent indentation for list items at the same level
Expected: 8; Actual: 2
(MD005, list-indent)
2064-2064: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
2064-2064: Hard tabs
Column: 1
(MD010, no-hard-tabs)
2065-2065: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
2066-2066: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
2071-2071: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
2072-2072: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
2073-2073: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
2074-2074: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
2080-2080: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
2250-2250: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
2319-2319: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
2380-2380: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
2381-2381: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
2382-2382: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
2382-2382: Hard tabs
Column: 1
(MD010, no-hard-tabs)
2383-2383: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
2383-2383: Hard tabs
Column: 1
(MD010, no-hard-tabs)
2399-2399: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
2400-2400: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
2406-2406: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
2513-2513: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
2645-2645: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
2829-2829: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
2941-2941: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/cn/docs/clients/restful-api/vertexlabel.md
18-18: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
22-22: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
118-118: Hard tabs
Column: 1
(MD010, no-hard-tabs)
178-178: Hard tabs
Column: 1
(MD010, no-hard-tabs)
179-179: Hard tabs
Column: 1
(MD010, no-hard-tabs)
180-180: Hard tabs
Column: 1
(MD010, no-hard-tabs)
181-181: Hard tabs
Column: 1
(MD010, no-hard-tabs)
182-182: Hard tabs
Column: 1
(MD010, no-hard-tabs)
183-183: Hard tabs
Column: 1
(MD010, no-hard-tabs)
246-246: Multiple headings with the same content
(MD024, no-duplicate-heading)
content/cn/docs/clients/restful-api/graphspace.md
22-22: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
100-100: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
131-131: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
202-202: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
270-270: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/cn/docs/clients/restful-api/indexlabel.md
15-15: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
61-61: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
125-125: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
156-156: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/cn/docs/clients/restful-api/propertykey.md
26-26: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/cn/docs/clients/restful-api/rank.md
21-21: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/cn/docs/clients/restful-api/vertex.md
54-54: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
101-101: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
154-154: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
257-257: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
363-363: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
433-433: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
437-437: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
465-465: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
473-473: Multiple headings with the same content
(MD024, no-duplicate-heading)
475-475: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
532-532: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
534-534: Multiple headings with the same content
(MD024, no-duplicate-heading)
536-536: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
600-600: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
638-638: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
642-642: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
652-652: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
656-656: Multiple headings with the same content
(MD024, no-duplicate-heading)
658-658: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/en/docs/clients/restful-api/graphspace.md
11-11: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
22-22: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
100-100: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
125-125: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
131-131: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
174-174: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
178-178: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
202-202: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
264-264: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
270-270: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/en/docs/clients/restful-api/vertex.md
228-228: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
429-429: Multiple headings with the same content
(MD024, no-duplicate-heading)
431-431: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (23)
content/en/docs/clients/restful-api/propertykey.md (1)
26-26: API 端点路径更新一致且正确。所有五个 PropertyKey 端点已按一致的模式更新，从
/graphs/hugegraph/迁移至/graphspaces/DEFAULT/graphs/hugegraph/：
- 创建（POST）- 第 26 行
- 更新用户数据（PUT）- 第 75 行
- 列表查询（GET）- 第 124 行
- 按名称查询（GET）- 第 203 行
- 删除（DELETE）- 第 239 行
端点路径更新与 PR 目标一致。
Also applies to: 75-75, 124-124, 203-203, 239-239
content/en/docs/clients/restful-api/indexlabel.md (1)
16-16: API 路径更新保持一致性。所有 IndexLabel 端点的 URL 路径已系统地从
/graphs/hugegraph/...更新为/graphspaces/DEFAULT/graphs/hugegraph/...，涵盖创建、查询、删除等操作和异步任务查询。更新保持一致，HTTP 方法和请求/响应结构未变。Also applies to: 62-62, 126-126, 157-157, 176-176
content/cn/docs/clients/restful-api/propertykey.md (1)
27-27: API 端点更新一致性良好。所有相关的 API 端点都已正确更新为新的
/graphspaces/DEFAULT/graphs/hugegraph/...路径格式，包括：
- POST 创建 PropertyKey (line 27)
- PUT 更新 userdata (line 76)
- GET 获取所有 PropertyKey (line 125)
- GET 按 name 获取 PropertyKey (line 204)
- DELETE 删除 PropertyKey (line 240)
Also applies to: 76-76, 125-125, 204-204, 240-240
content/cn/docs/clients/restful-api/indexlabel.md (2)
9-9: ✓ 间距和排版调整已正确应用。所有中文标题和说明文本中的间距已正确调整，符合中文排版规范。例如："创建一个 IndexLabel"、"获取所有的 IndexLabel"、"异步任务 RESTful API" 等，格式一致且规范。
Also applies to: 11-11, 57-57, 121-121, 150-150, 175-175
16-16: ✓ API 路径已正确更新至 GraphSpace 基础路径。所有 IndexLabel 端点的路径已完整更新，从
/graphs/hugegraph/迁移至/graphspaces/DEFAULT/graphs/hugegraph/，包括创建、查询全量、查询单个和删除操作。更新一致且完整。Also applies to: 62-62, 126-126, 157-157
content/cn/docs/clients/restful-api/rank.md (1)
156-156: 接口路径已正确更新为新的 GraphSpace 格式Personal Rank（第 156 行）和 Neighbor Rank（第 311 行）的接口路径已正确更新，从
/graphs/hugegraph/traversers/...迁移至/graphspaces/DEFAULT/graphs/hugegraph/traversers/...，与 PR 目标保持一致。建议验证：整个项目文档中的其他 API 端点是否均已同步更新为新的路径格式，以保持文档的一致性。
Also applies to: 311-311
content/cn/docs/clients/restful-api/vertexlabel.md (1)
1-6: ✅ 前言格式完整文档包含必需的前言信息（title、linkTitle、weight）。
content/en/docs/clients/restful-api/graphspace.md (1)
1-6: ✅ 前言格式完整新增的 Graphspace API 文档包含完整的前言信息（title、linkTitle、weight）。
content/en/docs/clients/restful-api/graphs.md (3)
1-6: ✅ 前言格式完整文档包含必需的前言信息。
9-10: ✅ 新增认证需求说明在文档开头明确说明 HugeGraph 1.7.0 之后动态创建图需要启用认证模式，这是重要的上下文信息。建议保留此提示。
16-16: API 端点一致性问题第 16 行的"获取所有图"端点仍为旧路径
GET http://localhost:8080/graphs，而其他操作已更新为新路径GET http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph。建议确认：
- 这是有意保留的向后兼容端点？
- 还是需要更新为新的 graphspaces 路径？
Also applies to: 41-41
content/cn/docs/clients/restful-api/auth.md (4)
1-6: ✅ 前言格式完整文档包含必需的前言信息。
55-55: ✅ API 路径一致性更新所有认证相关的 API 端点已正确更新为新的 graphspaces 前缀路径（
/graphspaces/DEFAULT/auth/...）。Also applies to: 89-89, 113-113, 156-156, 191-191, 222-222, 273-273, 305-305, 329-329, 369-369, 404-404, 467-467, 532-532, 586-586, 645-645, 700-700, 731-731, 756-756, 797-797, 832-832, 886-886, 919-919, 944-944, 985-985, 1021-1021
1044-1046: ✅ Manager API 节点前置条件说明10.7 图空间管理员（Manager）API 部分的前置条件说明清晰，要求用户先创建图空间并参考相关文档。
1070-1074: 理解字符串布尔值返回格式Manager API 的 check 操作返回字符串类型的布尔值（
"true"/"false"）而非标准 JSON 布尔值。文档已正确说明了返回值类型。注意：如果这是后端实际行为，建议在响应说明中明确标注这是字符串类型而非 boolean，以帮助 API 使用者避免类型错误。
content/cn/docs/clients/restful-api/vertex.md (2)
1-6: ✅ 前言格式完整文档包含必需的前言信息。
45-51: ✅ 路径参数文档完整所有主要操作已添加路径参数说明（graphspace、graph、id），清晰指出各参数含义。
Also applies to: 92-98, 144-151, 248-254, 353-360, 404-408, 590-597, 628-633
content/en/docs/clients/restful-api/auth.md (3)
1-6: ✅ 前言格式完整文档包含必需的前言信息。
50-50: ✅ API 路径一致性更新所有认证相关的 API 端点已正确更新为新的 graphspaces 前缀路径。
Also applies to: 84-84, 108-108, 152-152, 187-187, 218-218, 269-269, 301-301, 325-325, 366-366, 401-401, 462-462, 501-501, 525-525, 580-580, 639-639, 882-882, 914-914, 940-940, 985-985, 1021-1021
1044-1046: ✅ Manager API 前置条件清晰Graphspace Manager API 部分的前置条件说明清楚，要求先创建图空间。
content/cn/docs/clients/restful-api/edgelabel.md (1)
1-6: ✅ 前言格式完整文档包含必需的前言信息。
content/cn/docs/clients/restful-api/edge.md (2)
1-6: ✅ 前言格式完整文档包含必需的前言信息。
45-66: ✅ 路径参数文档完整所有主要操作已添加或更新路径参数说明（graphspace、graph、id）。
Also applies to: 130-132, 197-199, 257-259, 362-365, 416-418, 582-585, 622-625
|
|
||
| 1. 选定一个起点用户 u，其初始权重为 1.0，从 Vu 开始游走（有 alpha 的概率走到邻居点，1 - alpha 的概率停留）； | ||
| 2. 如果决定向外游走, 那么会选取某一个类型的出边, 例如 `rating` 来查找共同的打分人： | ||
| 2. 如果决定向外游走，那么会选取某一个类型的出边，例如 `rating` 来查找共同的打分人： |
There was a problem hiding this comment.
语法表达需调整
第 127 行"共同的打分人"在语法上不够准确。动词修饰应采用"形容词（副词）+地+动词"的形式，建议改为"共同地打分"。
修复如下：
-如果决定向外游走，那么会选取某一个类型的出边，例如 `rating` 来查找共同的打分人：
+如果决定向外游走，那么会选取某一个类型的出边，例如 `rating` 来查找共同地打分的人：📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| 2. 如果决定向外游走，那么会选取某一个类型的出边，例如 `rating` 来查找共同的打分人： | |
| 2. 如果决定向外游走，那么会选取某一个类型的出边，例如 `rating` 来查找共同地打分的人： |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~127-~127: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：共同"地"打分
Context: ...如果决定向外游走，那么会选取某一个类型的出边，例如 rating 来查找共同的打分人： 1. 那就从当前节点的邻居节点中按照均匀分布随机选择一个，并且按...
(wb4)
🤖 Prompt for AI Agents
In content/cn/docs/clients/restful-api/rank.md around line 127, the phrase
"共同的打分人" is grammatically awkward; replace it with a verb-modifier form such as
"共同地打分的人" (or "共同地打分的用户") to follow the "形容词/副词 + 地 + 动词" structure and keep the
meaning intact.
| - index_names：顶点类型创建的索引，详情见 3.4 | ||
| - nullable_keys：可为空的属性 | ||
| - user_data：设置顶点类型的通用信息，作用同属性类型 | ||
|
|
There was a problem hiding this comment.
修复代码块语言标识
多个代码块缺少语言标识，不符合 markdownlint 规范。建议为所有 Method & Url 代码块添加语言标识（使用 bash 或 text）。
例如：
-```
+```bash
POST http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/schema/vertexlabels
-```
+```bash影响范围：第 22、26、183、248 等行的代码块。
Also applies to: 26-26
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
22-22: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
In content/cn/docs/clients/restful-api/vertexlabel.md around lines 22, 26, 183,
248 (and any other Method & Url code blocks), several fenced code blocks are
missing a language identifier; update each opening fence to include a language
hint (e.g. ```bash or ```text) for the HTTP Method & Url blocks so they comply
with markdownlint; scan the file for other similar code fences and add the same
language identifier consistently.
| ``` | ||
|
|
||
| #### 1.3.2 为已存在的VertexLabel添加properties或userdata，或者移除userdata（目前不支持移除properties） | ||
| #### 1.3.2 为已存在的 VertexLabel 添加 properties 或 userdata，或者移除 userdata（目前不支持移除 properties） |
There was a problem hiding this comment.
移除硬制表符（Hard Tabs）
根据 markdownlint 分析，第 118 和 178-183 行包含硬制表符（Tab 字符），应替换为空格。
建议：统一使用 4 个空格进行缩进，而不是 Tab 字符。
Also applies to: 178-183
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
118-118: Hard tabs
Column: 1
(MD010, no-hard-tabs)
🤖 Prompt for AI Agents
In content/cn/docs/clients/restful-api/vertexlabel.md around lines 118 and
178-183, there are hard tab characters that markdownlint flags; replace each
hard tab with four space characters to standardize indentation, ensure the
Markdown renders correctly, and re-save the file using spaces-only indentation
for those lines.
| "group": "-69:all", | ||
| "target": "-77:all" |
There was a problem hiding this comment.
JSON 缩进不一致
部分 JSON 响应示例的缩进不统一。例如第 900-901 行的 group 和 target 字段缩进只有 2 个空格，而其他字段都是 4 个空格。
建议统一使用 4 个空格的缩进标准，以保持文档的格式一致性。
Also applies to: 965-972, 998-1007, 1034-1041
🤖 Prompt for AI Agents
In content/en/docs/clients/restful-api/auth.md around lines 900-901 (and
additionally 965-972, 998-1007, 1034-1041), several JSON response examples have
inconsistent indentation (some fields like "group" and "target" use 2 spaces
while others use 4); update those JSON blocks so every nested field uses 4-space
indentation consistently throughout each example, adjusting spacing for the
listed line ranges and any similar occurrences in the file to match the 4-space
standard.
There was a problem hiding this comment.
Actionable comments posted: 16
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (4)
content/cn/docs/clients/restful-api/_index.md (1)
1-5: 缺少前置元数据字段description根据编码规范，所有匹配
content/**/*.md的文档文件必须在 front matter 中包含description字段。当前前置元数据仅包含title、linkTitle和weight。建议添加
description字段到 front matter 中：--- title: "HugeGraph RESTful API" linkTitle: "RESTful API" weight: 1 +description: "HugeGraph RESTful API 文档说明" ---content/en/docs/clients/restful-api/gremlin.md (1)
1-5: 前置内容缺少description字段。根据编码指南，所有
content/**/*.md文档文件的前置内容必须包括 title、weight 和 description 字段。当前缺少description字段。description 字段通常会在渲染页面的 head 元素中作为 meta 元素显示。建议添加 description 字段：
--- title: "Gremlin API" linkTitle: "Gremlin" weight: 14 +description: "Gremlin API documentation for HugeGraph RESTful operations" ---content/en/docs/clients/restful-api/propertykey.md (1)
1-5: 在前置元数据中添加description字段。根据编码指南，所有位于
content/**/*.md的文档文件必须在前置元数据中包含 title、weight 和 description。当前文件缺少 description 字段。请更新前置元数据如下：
--- title: "PropertyKey API" linkTitle: "PropertyKey" weight: 2 +description: > + PropertyKey API documentation for HugeGraph. ---content/en/docs/clients/restful-api/auth.md (1)
894-1043: JSON 缩进不一致Authorization (Access) API 部分的 JSON 响应示例存在缩进不一致的问题。某些字段（如
group和target）只使用 2 个空格缩进，而其他字段使用 4 个空格。受影响的范围：
- 第901-902行（10.6.1 创建赋权）
- 第965-972行（10.6.3 修改赋权）
- 第998-1007行（10.6.4 查询赋权列表）
- 第1034-1041行（10.6.5 查询特定赋权）
建议统一使用 4 个空格缩进标准，确保所有嵌套字段的缩进一致：
{ "access_permission": "READ", "access_create": "2020-11-11 15:54:54.008", "id": "S-69:all>-88>11>S-77:all", "access_update": "2020-11-11 15:54:54.008", "access_creator": "admin", - "group": "-69:all", - "target": "-77:all" + "group": "-69:all", + "target": "-77:all" }
♻️ Duplicate comments (10)
content/cn/docs/clients/restful-api/propertykey.md (1)
26-28: 代码块缺少语言标识。请为代码块指定语言类型以启用语法高亮。HTTP请求应使用
http作为语言标识。建议修改如下：
##### Method & Url -``` +```http POST http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/schema/propertykeys</blockquote></details> <details> <summary>content/cn/docs/clients/restful-api/rebuild.md (1)</summary><blockquote> `13-15`: ** 代码块缺少语言标识** 三个 PUT 请求代码块都缺少语言标识。请为每个代码块添加 `http` 语言标识： ```diff ##### Method & Url -``` +```http PUT http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/jobs/rebuild/indexlabels/personByCity请对第 39-41 行和 65-67 行应用相同的修改。 Also applies to: 39-41, 65-67 </blockquote></details> <details> <summary>content/cn/docs/clients/restful-api/indexlabel.md (1)</summary><blockquote> `15-17`: ** 围栏代码块缺少语言指定** 所有围栏代码块应指定语言标识符。对于 URL 示例代码块，请使用 `text` 或 `bash` 作为语言标识符： ```diff ##### Method & Url -``` +```text POST http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/schema/indexlabels请对其他三个类似的代码块（第 61-63、125-127、156-158 行）应用相同的修改。 Also applies to: 61-63, 125-127, 156-158 </blockquote></details> <details> <summary>content/cn/docs/clients/restful-api/graphs.md (1)</summary><blockquote> `155-155`: ** 代码块缺少语言标识** 第 155 行的代码块缺少语言标识。请添加 `text` 或 `bash` 标识： ```diff -``` +```text POST http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph_clone?clone_graph_name=hugegraph -``` +```content/cn/docs/clients/restful-api/gremlin.md (1)
193-195: ** 为代码块指定语言标识**HTTP 请求代码块应指定语言类型。请使用
http或bash作为语言标识：-``` +```http POST http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/jobs/gremlin -``` +```content/cn/docs/clients/restful-api/vertex.md (1)
54-54: ** 代码块缺少语言标识**多个 Method & Url 代码块缺少语言标识。建议为所有代码块添加
bash标识：-``` +```bash POST http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/graph/vertices -``` +```请对以下行应用相同的修改：101、154、257、363、437、475、536、600、642、658。
Also applies to: 101-101, 154-154, 257-257, 363-363, 437-437, 475-475, 536-536, 600-600, 642-642, 658-658
content/cn/docs/clients/restful-api/graphspace.md (1)
23-23: ** 代码块缺少语言标识**多个 Method & Url 代码块缺少语言标识。建议为所有代码块添加
bash标识：-``` +```bash POST http://localhost:8080/graphspaces -``` +```请对第 101、132、203、271 行应用相同的修改。
Also applies to: 101-101, 132-132, 203-203, 271-271
content/cn/docs/clients/restful-api/rank.md (1)
156-156: ** 代码块缺少语言标识**两个 POST 请求代码块缺少语言标识。请添加
bash或http标识：##### Method & Url -``` +```bash POST http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/traversers/personalrank -``` +```请对第 311 行应用相同的修改。
Also applies to: 311-311
content/cn/docs/clients/restful-api/edgelabel.md (1)
26-26: 代码块缺少语言标识多个 Method & Url 代码块缺少语言标识。根据markdownlint-cli2规则(MD040)，应该为所有代码块指定语言类型。建议将这些代码块的开始标记从
改为bash ：##### Method & Url -``` +```bash POST http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/schema/edgelabels -``` +```bash需要修复的行：26、136、189、251、293
Also applies to: 136-136, 189-189, 251-251, 293-293
content/cn/docs/clients/restful-api/edge.md (1)
81-81: 代码块缺少语言标识多个 Method & Url 代码块缺少语言标识。根据markdownlint-cli2规则(MD040)，应该为所有代码块指定语言类型。建议将这些代码块的开始标记从
改为bash ：##### Method & Url -``` +```bash POST http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/graph/edges -``` +```bash需要修复的行：81、144、212、275、377、452、488、589、635、651
Also applies to: 144-144, 212-212, 275-275, 377-377, 452-452, 488-488, 589-589, 635-635, 651-651
🧹 Nitpick comments (5)
content/cn/docs/clients/restful-api/_index.md (1)
7-12: 缺少原始功能描述版本兼容性说明已经很完善，但根据之前的审查意见，建议保留或补充关于 HugeGraph-Server 功能的原始描述。这将帮助用户理解该 API 文档的整体用途，而不仅是版本差异。
建议在版本兼容性说明之后添加功能描述：
> - 旧版本 doc 参考：[HugeGraph 1.5.x RESTful API](https://github.com/apache/incubator-hugegraph-doc/tree/release-1.5.0) + +HugeGraph-Server 通过 HugeGraph-API 基于 HTTP 协议为 Client 提供操作图的接口，主要包括元数据和图数据的增删改查、遍历算法、变量、图操作及其他操作。 除了下方的文档，你还可以通过content/en/docs/clients/restful-api/schema.md (1)
1-5: 文档缺少description字段根据编码指南，所有documentation文件应该在前置元数据中包含
description字段。当前文件只有title、linkTitle和weight。建议添加
description字段：--- title: "Schema API" linkTitle: "Schema" weight: 1 +description: "HugeGraph Schema API documentation" ---content/en/docs/clients/restful-api/edge.md (1)
1-5: 文档缺少description字段根据编码指南，所有documentation文件应该在前置元数据中包含
description字段。当前文件只有title、linkTitle和weight。建议添加
description字段以完善文档元数据。content/en/docs/clients/restful-api/vertex.md (1)
1-5: 文档缺少description字段根据编码指南，所有documentation文件应该在前置元数据中包含
description字段。当前文件只有title、linkTitle和weight。建议添加
description字段以完善文档元数据。content/en/docs/clients/restful-api/graphs.md (1)
1-5: 文档缺少description字段根据编码指南，所有documentation文件应该在前置元数据中包含
description字段。当前文件只有title、linkTitle和weight。建议添加
description字段以完善文档元数据。
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (38)
content/cn/docs/clients/restful-api/_index.md(1 hunks)content/cn/docs/clients/restful-api/auth.md(37 hunks)content/cn/docs/clients/restful-api/cypher.md(2 hunks)content/cn/docs/clients/restful-api/edge.md(18 hunks)content/cn/docs/clients/restful-api/edgelabel.md(7 hunks)content/cn/docs/clients/restful-api/graphs.md(15 hunks)content/cn/docs/clients/restful-api/graphspace.md(1 hunks)content/cn/docs/clients/restful-api/gremlin.md(7 hunks)content/cn/docs/clients/restful-api/indexlabel.md(5 hunks)content/cn/docs/clients/restful-api/propertykey.md(5 hunks)content/cn/docs/clients/restful-api/rank.md(4 hunks)content/cn/docs/clients/restful-api/rebuild.md(4 hunks)content/cn/docs/clients/restful-api/schema.md(2 hunks)content/cn/docs/clients/restful-api/task.md(4 hunks)content/cn/docs/clients/restful-api/traverser.md(40 hunks)content/cn/docs/clients/restful-api/variable.md(4 hunks)content/cn/docs/clients/restful-api/vertex.md(14 hunks)content/cn/docs/clients/restful-api/vertexlabel.md(7 hunks)content/cn/docs/quickstart/hugegraph/hugegraph-server.md(4 hunks)content/en/docs/clients/restful-api/_index.md(1 hunks)content/en/docs/clients/restful-api/auth.md(41 hunks)content/en/docs/clients/restful-api/cypher.md(3 hunks)content/en/docs/clients/restful-api/edge.md(11 hunks)content/en/docs/clients/restful-api/edgelabel.md(6 hunks)content/en/docs/clients/restful-api/graphs.md(14 hunks)content/en/docs/clients/restful-api/graphspace.md(1 hunks)content/en/docs/clients/restful-api/gremlin.md(3 hunks)content/en/docs/clients/restful-api/indexlabel.md(5 hunks)content/en/docs/clients/restful-api/propertykey.md(5 hunks)content/en/docs/clients/restful-api/rank.md(2 hunks)content/en/docs/clients/restful-api/rebuild.md(4 hunks)content/en/docs/clients/restful-api/schema.md(1 hunks)content/en/docs/clients/restful-api/task.md(4 hunks)content/en/docs/clients/restful-api/traverser.md(7 hunks)content/en/docs/clients/restful-api/variable.md(4 hunks)content/en/docs/clients/restful-api/vertex.md(11 hunks)content/en/docs/clients/restful-api/vertexlabel.md(6 hunks)content/en/docs/quickstart/hugegraph/hugegraph-server.md(6 hunks)
🚧 Files skipped from review as they are similar to previous changes (9)
- content/cn/docs/clients/restful-api/cypher.md
- content/en/docs/clients/restful-api/traverser.md
- content/en/docs/clients/restful-api/rebuild.md
- content/cn/docs/quickstart/hugegraph/hugegraph-server.md
- content/en/docs/clients/restful-api/edgelabel.md
- content/cn/docs/clients/restful-api/task.md
- content/en/docs/quickstart/hugegraph/hugegraph-server.md
- content/en/docs/clients/restful-api/_index.md
- content/en/docs/clients/restful-api/task.md
🧰 Additional context used
📓 Path-based instructions (1)
content/**/*.md
📄 CodeRabbit inference engine (AGENTS.md)
Include front matter (title, weight, description) in all documentation files
Files:
content/cn/docs/clients/restful-api/_index.mdcontent/en/docs/clients/restful-api/graphs.mdcontent/en/docs/clients/restful-api/vertexlabel.mdcontent/en/docs/clients/restful-api/schema.mdcontent/cn/docs/clients/restful-api/edgelabel.mdcontent/en/docs/clients/restful-api/rank.mdcontent/cn/docs/clients/restful-api/traverser.mdcontent/en/docs/clients/restful-api/auth.mdcontent/en/docs/clients/restful-api/edge.mdcontent/en/docs/clients/restful-api/gremlin.mdcontent/cn/docs/clients/restful-api/schema.mdcontent/cn/docs/clients/restful-api/graphspace.mdcontent/en/docs/clients/restful-api/cypher.mdcontent/cn/docs/clients/restful-api/edge.mdcontent/cn/docs/clients/restful-api/vertex.mdcontent/en/docs/clients/restful-api/indexlabel.mdcontent/en/docs/clients/restful-api/variable.mdcontent/cn/docs/clients/restful-api/graphs.mdcontent/cn/docs/clients/restful-api/auth.mdcontent/cn/docs/clients/restful-api/gremlin.mdcontent/cn/docs/clients/restful-api/indexlabel.mdcontent/cn/docs/clients/restful-api/propertykey.mdcontent/cn/docs/clients/restful-api/rank.mdcontent/cn/docs/clients/restful-api/rebuild.mdcontent/cn/docs/clients/restful-api/variable.mdcontent/cn/docs/clients/restful-api/vertexlabel.mdcontent/en/docs/clients/restful-api/graphspace.mdcontent/en/docs/clients/restful-api/propertykey.mdcontent/en/docs/clients/restful-api/vertex.md
🪛 LanguageTool
content/cn/docs/clients/restful-api/traverser.md
[uncategorized] ~13-~13: 您的意思是“"不"可”？
Context: ...rser API 包括： - K-out API，根据起始顶点，查找恰好 N 步可达的邻居，分为基础版和高级版： - 基础版使用 GET 方法，根据起始...
(BU)
[uncategorized] ~14-~14: 您的意思是“"不"可”？
Context: ...版和高级版： - 基础版使用 GET 方法，根据起始顶点，查找恰好 N 步可达的邻居 - 高级版使用 POST 方法，根据起始顶点，查找恰好 N ...
(BU)
[uncategorized] ~15-~15: 您的意思是“"不"可”？
Context: ...可达的邻居 - 高级版使用 POST 方法，根据起始顶点，查找恰好 N 步可达的邻居，与基础版的不同在于： - 支持只统计邻居数量 ...
(BU)
[uncategorized] ~19-~19: 您的意思是“"不"以内”？
Context: ...回到达邻居的最短路径 - K-neighbor API，根据起始顶点，查找 N 步以内可达的所有邻居，分为基础版和高级版： - 基础版使用 GET 方法，...
(BU)
[uncategorized] ~20-~20: 您的意思是“"不"以内”？
Context: ...基础版和高级版： - 基础版使用 GET 方法，根据起始顶点，查找 N 步以内可达的所有邻居 - 高级版使用 POST 方法，根据起始顶点，查找 ...
(BU)
[uncategorized] ~21-~21: 您的意思是“"不"以内”？
Context: ...可达的所有邻居 - 高级版使用 POST 方法，根据起始顶点，查找 N 步以内可达的所有邻居，与基础版的不同在于： - 支持只统计邻居数量...
(BU)
[uncategorized] ~197-~197: 您的意思是“"不"可”？
Context: ...、方向、边的类型（可选）和深度 depth，查找从起始顶点出发恰好 depth 步可达的顶点 ###### Params - source：起始顶点 id，必...
(BU)
[uncategorized] ~237-~237: 您的意思是“"不"关系”？
Context: ... ] } ``` ##### 3.2.1.3 适用场景 查找恰好 N 步关系可达的顶点。两个例子： - 家族关系中，查找一个人的所有孙子，person...
(BU)
[uncategorized] ~246-~246: 您的意思是“"不"可”？
Context: ...方向、边类型和过滤属性）和深度 depth，查找从起始顶点出发恰好 depth 步可达的顶点。 > 与 K-out 基础版的不同在于： > - 支持只统计邻居数...
(BU)
[uncategorized] ~438-~438: 您的意思是“"不"之内”？
Context: ...点、方向、边的类型（可选）和深度 depth，查找包括起始顶点在内、depth 步之内可达的所有顶点 > 相当于：起始顶点、K-out(1)、K-out(2)、...
(BU)
[uncategorized] ~482-~482: 您的意思是“"不"以内”？
Context: ..." ] } ``` ##### 3.2.3.3 适用场景 查找 N 步以内可达的所有顶点，例如： - 家族关系中，查找一个人五服以内所有子孙，per...
(BU)
[uncategorized] ~492-~492: 您的意思是“"不"内”？
Context: ...包括方向、边类型和过滤属性）和深度 depth，查找从起始顶点出发 depth 步内可达的所有顶点。 > 与 K-neighbor 基础版的不同在于： > - ...
(BU)
[uncategorized] ~1649-~1649: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：重"地"降
Context: ...- INCR 表示按照路径权重的升序排序 - DECR 表示按照路径权重的降序排序 - capacity：遍历过程中最大的访问的顶点数目，选填项，默认为 ...
(wb4)
content/cn/docs/clients/restful-api/rank.md
[uncategorized] ~127-~127: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：共同"地"打分
Context: ...如果决定向外游走，那么会选取某一个类型的出边，例如 rating 来查找共同的打分人： 1. 那就从当前节点的邻居节点中按照均匀分布随机选择一个，并且按...
(wb4)
content/en/docs/clients/restful-api/graphspace.md
[style] ~280-~280: Replacing this phrase with a shorter alternative might make your text sound more refined.
Context: ... graphspace releases all resources that belong to it.
(BELONG_TO_PRP)
🪛 markdownlint-cli2 (0.18.1)
content/cn/docs/clients/restful-api/edgelabel.md
26-26: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/cn/docs/clients/restful-api/traverser.md
14-14: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
15-15: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
16-16: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
17-17: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
18-18: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
20-20: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
21-21: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
22-22: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
23-23: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
24-24: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
27-27: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
28-28: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
35-35: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
36-36: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
45-45: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
46-46: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
46-46: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
46-46: Hard tabs
Column: 1
(MD010, no-hard-tabs)
47-47: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
47-47: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
47-47: Hard tabs
Column: 1
(MD010, no-hard-tabs)
49-49: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
50-50: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
50-50: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
50-50: Hard tabs
Column: 1
(MD010, no-hard-tabs)
51-51: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
51-51: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
51-51: Hard tabs
Column: 1
(MD010, no-hard-tabs)
214-214: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
257-257: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
258-258: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
259-259: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
260-260: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
261-261: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
262-262: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
263-263: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
264-264: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
265-265: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
271-271: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
272-272: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
273-273: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
274-274: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
276-276: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
277-277: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
278-278: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
279-279: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
288-288: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
455-455: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
503-503: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
504-504: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
505-505: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
506-506: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
507-507: Unordered list indentation
Expected: 6; Actual: 12
(MD007, ul-indent)
508-508: Unordered list indentation
Expected: 6; Actual: 12
(MD007, ul-indent)
509-509: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
510-510: Unordered list indentation
Expected: 6; Actual: 12
(MD007, ul-indent)
511-511: Unordered list indentation
Expected: 6; Actual: 12
(MD007, ul-indent)
512-512: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
513-513: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
518-518: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
519-519: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
520-520: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
521-521: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
523-523: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
524-524: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
525-525: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
526-526: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
533-533: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
754-754: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
798-798: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
832-832: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
833-833: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
833-833: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
833-833: Hard tabs
Column: 1
(MD010, no-hard-tabs)
834-834: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
834-834: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
834-834: Hard tabs
Column: 1
(MD010, no-hard-tabs)
835-835: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
836-836: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
844-844: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
904-904: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
954-954: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1018-1018: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1103-1103: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1236-1236: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1237-1237: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1238-1238: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
1238-1238: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1239-1239: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
1239-1239: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1242-1242: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1243-1243: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
1243-1243: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
1243-1243: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1244-1244: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
1244-1244: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
1244-1244: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1245-1245: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1246-1246: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1255-1255: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1483-1483: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1531-1531: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1532-1532: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1533-1533: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
1533-1533: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1534-1534: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
1534-1534: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1537-1537: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1538-1538: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1539-1539: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
1539-1539: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1540-1540: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
1540-1540: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1543-1543: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1544-1544: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
1544-1544: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
1544-1544: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1545-1545: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
1545-1545: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
1545-1545: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1546-1546: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1547-1547: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1559-1559: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1633-1633: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1634-1634: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1635-1635: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
1635-1635: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1636-1636: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
1636-1636: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1639-1639: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1640-1640: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
1640-1640: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
1640-1640: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1641-1641: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
1641-1641: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
1641-1641: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1642-1642: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1643-1643: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1644-1644: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1645-1645: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1647-1647: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1648-1648: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1649-1649: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1658-1658: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1820-1820: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1821-1821: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1822-1822: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
1822-1822: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1823-1823: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
1823-1823: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1826-1826: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1827-1827: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1828-1828: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
1828-1828: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1829-1829: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
1829-1829: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1832-1832: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1833-1833: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
1833-1833: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
1833-1833: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1834-1834: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 1
(MD005, list-indent)
1834-1834: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
1834-1834: Hard tabs
Column: 1
(MD010, no-hard-tabs)
1835-1835: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1836-1836: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1837-1837: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
1847-1847: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
2011-2011: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
2054-2054: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
2055-2055: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
2056-2056: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
2056-2056: Hard tabs
Column: 1
(MD010, no-hard-tabs)
2057-2057: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
2057-2057: Hard tabs
Column: 1
(MD010, no-hard-tabs)
2061-2061: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
2062-2062: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
2063-2063: Inconsistent indentation for list items at the same level
Expected: 8; Actual: 2
(MD005, list-indent)
2063-2063: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
2063-2063: Hard tabs
Column: 1
(MD010, no-hard-tabs)
2064-2064: Inconsistent indentation for list items at the same level
Expected: 8; Actual: 2
(MD005, list-indent)
2064-2064: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
2064-2064: Hard tabs
Column: 1
(MD010, no-hard-tabs)
2065-2065: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
2066-2066: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
2071-2071: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
2072-2072: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
2073-2073: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
2074-2074: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
2080-2080: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
2250-2250: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
2319-2319: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
2380-2380: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
2381-2381: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
2382-2382: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
2382-2382: Hard tabs
Column: 1
(MD010, no-hard-tabs)
2383-2383: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
2383-2383: Hard tabs
Column: 1
(MD010, no-hard-tabs)
2399-2399: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
2400-2400: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
2406-2406: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
2513-2513: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
2645-2645: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
2829-2829: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
2941-2941: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/en/docs/clients/restful-api/auth.md
1059-1059: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1085-1085: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1124-1124: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1156-1156: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1180-1180: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/cn/docs/clients/restful-api/graphspace.md
23-23: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
101-101: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
132-132: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
203-203: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
271-271: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/en/docs/clients/restful-api/cypher.md
24-24: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
29-29: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
87-87: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
content/cn/docs/clients/restful-api/vertex.md
47-47: Link fragments should be valid
(MD051, link-fragments)
content/cn/docs/clients/restful-api/graphs.md
155-155: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/cn/docs/clients/restful-api/auth.md
1059-1059: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1085-1085: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1124-1124: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1156-1156: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1180-1180: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/cn/docs/clients/restful-api/indexlabel.md
15-15: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
61-61: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
125-125: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
156-156: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/cn/docs/clients/restful-api/propertykey.md
26-26: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
203-203: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/cn/docs/clients/restful-api/rank.md
144-144: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
145-145: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
146-146: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
155-155: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
302-302: Inconsistent indentation for list items at the same level
Expected: 1; Actual: 4
(MD005, list-indent)
302-302: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
303-303: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
303-303: Hard tabs
Column: 1
(MD010, no-hard-tabs)
310-310: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/cn/docs/clients/restful-api/rebuild.md
13-13: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
39-39: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
65-65: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/cn/docs/clients/restful-api/variable.md
46-46: Hard tabs
Column: 1
(MD010, no-hard-tabs)
content/cn/docs/clients/restful-api/vertexlabel.md
27-27: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
182-182: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
247-247: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
290-290: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/en/docs/clients/restful-api/graphspace.md
15-15: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
61-61: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
125-125: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
156-156: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
content/en/docs/clients/restful-api/propertykey.md
75-75: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
124-124: Hard tabs
Column: 1
(MD010, no-hard-tabs)
203-203: Hard tabs
Column: 1
(MD010, no-hard-tabs)
content/en/docs/clients/restful-api/vertex.md
228-228: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
429-429: Multiple headings with the same content
(MD024, no-duplicate-heading)
431-431: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (10)
content/en/docs/clients/restful-api/indexlabel.md (2)
1-5: Front matter 完整且符合规范。文档包含所有必需的 front matter 元素（title、linkTitle、weight）。
16-16: GraphSpace 路径迁移一致且完整。所有 API 端点路径已从
/graphs/hugegraph/统一迁移到/graphspaces/DEFAULT/graphs/hugegraph/，包括异步任务查询 URL 的参考。路径迁移模式与 PR 目标相符，格式调整（"->" → ">"）亦符合 Markdown 标准。Also applies to: 62-62, 126-126, 157-157, 176-176
content/cn/docs/clients/restful-api/propertykey.md (1)
1-5: Front matter完整且符合要求。文档包含必需的front matter元素（title、linkTitle、weight）。API路径已正确更新为使用
/graphspaces/DEFAULT/graphs/hugegraph前缀，与PR目标一致。content/en/docs/clients/restful-api/gremlin.md (2)
191-191: 异步 Gremlin 端点路径更新正确。异步 Gremlin 任务提交的端点路径已正确更新为新的 GraphSpace 格式。
227-227: 任务状态查询路径更新一致。任务状态查询的 GET 端点引用已一致性地更新为使用新的路径格式
/graphspaces/DEFAULT/graphs/hugegraph/tasks/{id}，与异步任务提交端点的路径前缀保持对应关系。Also applies to: 258-258
content/en/docs/clients/restful-api/propertykey.md (1)
26-26: API 端点路径迁移一致性验证通过。所有五个 PropertyKey 操作端点（创建、追加/删除用户数据、获取所有、按名称获取、按名称删除）都已正确更新为新的 graphspaces 格式：
/graphspaces/DEFAULT/graphs/hugegraph/schema/propertykeys。迁移是一致且完整的。Also applies to: 75-75, 124-124, 203-203, 239-239
content/en/docs/clients/restful-api/graphspace.md (1)
1-6: ✓ 前置内容完整文档已包含所有必需的前置字段（title、linkTitle、weight、description），符合编码指南要求。
content/cn/docs/clients/restful-api/graphspace.md (1)
1-6: ✓ 前置内容完整且数据一致性已修复文档已包含所有必需的前置字段（title、linkTitle、weight、description）。根据过去的评论，请求体和响应体的数据一致性问题（auth 字段、memory_limit 值、更新操作的返回值）已得到修复。
content/cn/docs/clients/restful-api/auth.md (1)
1045-1201: 新增 Manager API 文档结构良好新增的 10.7 Graphspace Manager（Manager）API 部分文档完善，包括：
✅ 清晰的前置条件说明（第1047行）
✅ 明确的API用途描述（第1049-1050行）
✅ 5个操作的完整覆盖：检查、列表、授权、撤销、查询角色
✅ 完整的参数说明和请求/响应示例建议修复代码块语言标识问题后，此部分文档将更加完整。
content/en/docs/clients/restful-api/auth.md (1)
1045-1201: 新增 Manager API 文档结构良好新增的 10.7 Graphspace Manager（Manager）API 部分文档完善，包括：
✅ 清晰的前置条件说明（第1047行）
✅ 明确的API用途描述（第1049-1050行）
✅ 5个操作的完整覆盖：检查、列表、授权、撤销、查询角色
✅ 完整的参数说明和请求/响应示例
✅ gs1 图空间的具体示例建议修复代码块语言标识和JSON缩进问题后，此部分文档将更加完整。
| ``` | ||
| GET http://localhost:8080/graphspaces/gs1/auth/managers/check?type=WRITE |
There was a problem hiding this comment.
Manager API部分代码块缺少语言标识
新增的 10.7 Manager API 中，多个 Method & Url 代码块缺少语言标识。根据markdownlint-cli2规则(MD040)，应该为所有代码块指定语言类型。建议将这些代码块的开始标记从 改为bash ：
##### Method & Url
-```
+```bash
GET http://localhost:8080/graphspaces/gs1/auth/managers/check?type=WRITE
-```
+```bash需要修复的行：1060、1086、1125、1157、1181
Also applies to: 1085-1086, 1124-1125, 1156-1157, 1180-1181
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
1059-1059: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
In content/cn/docs/clients/restful-api/auth.md around lines 1059-1181, several
Method & Url code fences are missing a language identifier; update the opening
fences for the code blocks that currently use ``` to ```bash on the specified
lines (1060, 1086, 1125, 1157, 1181 — also ensure the paired openings at
1085-1086, 1124-1125, 1156-1157, 1180-1181 are changed where applicable) so
every code block has a language tag per MD040; keep the existing closing ```
unchanged.
|
|
||
| ``` | ||
| GET http://localhost:8080/graphs/hugegraph/schema/propertykeys | ||
| GET http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/schema/propertykeys |
There was a problem hiding this comment.
删除代码块内的硬制表符。
根据静态分析工具标记，第 124 行代码块中存在硬制表符，应使用空格替代。
-GET http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/schema/propertykeys
+GET http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/schema/propertykeys📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| GET http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/schema/propertykeys | |
| GET http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/schema/propertykeys |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
124-124: Hard tabs
Column: 1
(MD010, no-hard-tabs)
🤖 Prompt for AI Agents
In content/en/docs/clients/restful-api/propertykey.md at line 124, the code
block contains hard tab characters; replace any tab characters on that line (and
within the code block if present) with spaces (preferably 2 or 4 spaces
consistent with the repository style), ensuring indentation is preserved using
spaces only and re-save the file without tabs.
Summary by CodeRabbit
新功能
文档更新
✏️ Tip: You can customize this high-level summary in your review settings.