From 4305a2374a8820c7ad6da31207b2fdced44b1d1c Mon Sep 17 00:00:00 2001 From: Shuduo Sang Date: Sat, 24 Sep 2022 16:02:32 +0800 Subject: [PATCH] docs: refine rest api doc (#17050) * docs: add more clear desc * doc: fix ../zh/08-connector/02-rest-api.mdx --- docs/en/14-reference/02-rest-api/02-rest-api.mdx | 4 ++-- docs/zh/08-connector/02-rest-api.mdx | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/en/14-reference/02-rest-api/02-rest-api.mdx b/docs/en/14-reference/02-rest-api/02-rest-api.mdx index ce28ee87d9..da26b34c6f 100644 --- a/docs/en/14-reference/02-rest-api/02-rest-api.mdx +++ b/docs/en/14-reference/02-rest-api/02-rest-api.mdx @@ -123,7 +123,7 @@ where `TOKEN` is the string after Base64 encoding of `{username}:{password}`, e. ### HTTP body structure -#### Successful Operation +#### Successful Insert Operation Example: @@ -143,7 +143,7 @@ Description: - rows: (`int`) Only returns `1`. - data: (`[][]any`) Returns the number of rows affected. -#### Successful Query +#### Successful Query Operation Example: diff --git a/docs/zh/08-connector/02-rest-api.mdx b/docs/zh/08-connector/02-rest-api.mdx index 12a9cf5347..a8e1682301 100644 --- a/docs/zh/08-connector/02-rest-api.mdx +++ b/docs/zh/08-connector/02-rest-api.mdx @@ -125,7 +125,7 @@ curl -L -u username:password -d "" :/rest/sql/[db_name] ### HTTP body 结构 -#### 正确执行 +#### 正确执行插入 样例: @@ -145,7 +145,7 @@ curl -L -u username:password -d "" :/rest/sql/[db_name] - rows:(`int`)只返回 `1`。 - data:(`[][]any`)返回受影响行数。 -#### 正确查询 +#### 正确执行查询 样例: