xxq250
/
homework-jianmu
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

docs: refine rest api doc (#17050) 

* docs: add more clear desc

* doc: fix ../zh/08-connector/02-rest-api.mdx
This commit is contained in:
Shuduo Sang 2022-09-24 16:02:32 +08:00 committed by GitHub
parent eb00e378c4
commit 4305a2374a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/en/14-reference/02-rest-api/02-rest-api.mdx
View File

@ -123,7 +123,7 @@ where `TOKEN` is the string after Base64 encoding of `{username}:{password}`, e.
### HTTP body structure ### HTTP body structure
#### Successful Operation #### Successful Insert Operation
Example: Example:
@ -143,7 +143,7 @@ Description:
- rows: (`int`) Only returns `1`. - rows: (`int`) Only returns `1`.
- data: (`[][]any`) Returns the number of rows affected. - data: (`[][]any`) Returns the number of rows affected.
#### Successful Query #### Successful Query Operation
Example: Example:

4
docs/zh/08-connector/02-rest-api.mdx
View File

@ -125,7 +125,7 @@ curl -L -u username:password -d "<SQL>" <ip>:<PORT>/rest/sql/[db_name]
### HTTP body 结构 ### HTTP body 结构
#### 正确执行 #### 正确执行插入
样例： 样例：
@ -145,7 +145,7 @@ curl -L -u username:password -d "<SQL>" <ip>:<PORT>/rest/sql/[db_name]
- rows：（`int`）只返回 `1`。 - rows：（`int`）只返回 `1`。
- data：（`[][]any`）返回受影响行数。 - data：（`[][]any`）返回受影响行数。
#### 正确查询 #### 正确执行查询
样例： 样例：