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

docs: use json instead of table in rest api (#20895) 

* docs: add rest api diff

* docs: use html table

* docs: use json instead of table in rest api doc
This commit is contained in:
Shuduo Sang 2023-04-12 21:46:19 +08:00 committed by GitHub
parent c3abf5ede7
commit c1412648d0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 97 additions and 98 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -405,17 +405,11 @@ Response body:
### Response body ### Response body
<table> #### REST response body return from TDengine 2.x
<tr>
<td> Response body </td> <td> TDengine 2.x </td> <td> TDengine 3.0 </td> ```JSON
</tr> {
<tr> "status": "succ",
<td> Success </td> <td> "status": "succ",</td> <td> "code": 0,</td>
/<tr>
<tr>
<td> Column meta </td>
<td>
```
"head": [ "head": [
"name", "name",
"created_time", "created_time",
@ -435,36 +429,6 @@ Response body:
"precision", "precision",
"status" "status"
], ],
```
</td>
<td>
```
"column_meta": [
[
"name",
"VARCHAR",
64
],
[
"ntables",
"BIGINT",
8
],
[
"status",
"VARCHAR",
10
]
],
```
</td>
</tr>
<tr>
<td>
Data
</td>
<td>
```
"data": [ "data": [
[ [
"log", "log",
@ -486,9 +450,9 @@ Data
"ready" "ready"
] ]
], ],
"rows": 1
}
``` ```
</td>
<td>
``` ```
"data": [ "data": [
[ [
@ -503,9 +467,44 @@ Data
] ]
], ],
``` ```
</td>
</tr> #### REST response body return from TDengine 3.0
</table>
```JSON
{
"code": 0,
"column_meta": [
[
"name",
"VARCHAR",
64
],
[
"ntables",
"BIGINT",
8
],
[
"status",
"VARCHAR",
10
]
],
"data": [
[
"information_schema",
16,
"ready"
],
[
"performance_schema",
9,
"ready"
]
],
"rows": 2
}
```
## Reference ## Reference

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

@ -408,17 +408,11 @@ curl http://192.168.0.1:6041/rest/login/root/taosdata
### 响应代码和消息体 ### 响应代码和消息体
<table> #### TDengine 2.x 响应代码和消息体
<tr>
<td> 响应代码和消息体 </td> <td> TDengine 2.x </td> <td> TDengine 3.0 </td> ```JSON
</tr> {
<tr> "status": "succ",
<td> Success </td> <td> "status": "succ",</td> <td> "code": 0,</td>
/<tr>
<tr>
<td> Column meta </td>
<td>
```
"head": [ "head": [
"name", "name",
"created_time", "created_time",
@ -438,36 +432,6 @@ curl http://192.168.0.1:6041/rest/login/root/taosdata
"precision", "precision",
"status" "status"
], ],
```
</td>
<td>
```
"column_meta": [
[
"name",
"VARCHAR",
64
],
[
"ntables",
"BIGINT",
8
],
[
"status",
"VARCHAR",
10
]
],
```
</td>
</tr>
<tr>
<td>
Data
</td>
<td>
```
"data": [ "data": [
[ [
"log", "log",
@ -489,9 +453,9 @@ Data
"ready" "ready"
] ]
], ],
"rows": 1
}
``` ```
</td>
<td>
``` ```
"data": [ "data": [
[ [
@ -506,9 +470,45 @@ Data
] ]
], ],
``` ```
</td>
</tr> #### TDengine 3.0 响应代码和消息体
</table>
```JSON
{
"code": 0,
"column_meta": [
[
"name",
"VARCHAR",
64
],
[
"ntables",
"BIGINT",
8
],
[
"status",
"VARCHAR",
10
]
],
"data": [
[
"information_schema",
16,
"ready"
],
[
"performance_schema",
9,
"ready"
]
],
"rows": 2
}
```
## 参考 ## 参考