Skip to content

docs: fix parameter format in tidb_http_api.md #56665

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 19, 2024
Merged

docs: fix parameter format in tidb_http_api.md #56665

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
47960a8
Update tidb_http_api.md
shawn0915 Oct 16, 2024
ef89af3
Update docs/tidb_http_api.md
shawn0915 Oct 16, 2024
75a6978
Update tidb_http_api.md
shawn0915 Nov 19, 2024
25a1360
Update tidb_http_api.md
shawn0915 Nov 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions docs/tidb_http_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,11 +232,11 @@
If the handle is clustered, specify the primary key column values in the query string

```shell
$curl http://{TiDBIP}:10080/mvcc/key/{db}/{table}?${c1}={v1}&${c2}=${v2}
$curl "http://{TiDBIP}:10080/mvcc/key/{db}/{table}?${c1}={v1}&${c2}=${v2}"
```

```shell
$curl http://127.0.0.1:10080/mvcc/key/test/t\?a\=aaa\&b\=2020-01-01
$curl "http://127.0.0.1:10080/mvcc/key/test/t?a=aaa&b=2020-01-01"
{
"key": "7480000000000000365F72016161610000000000FA0419A5420000000000",
"region_id": 52,
Expand Down Expand Up @@ -387,14 +387,14 @@
14. Get MVCC Information of a specified index key, argument example: column_name_1=column_value_1&column_name_2=column_value2...

```shell
curl http://{TiDBIP}:10080/mvcc/index/{db}/{table}/{index}/{handle}?${c1}={v1}&${c2}=${v2}
curl "http://{TiDBIP}:10080/mvcc/index/{db}/{table}/{index}/{handle}?${c1}={v1}&${c2}=${v2}"
```

*Hint: For the index column which column type is timezone dependent, e.g. `timestamp`, convert its value to UTC
timezone.*

```shell
$curl http://127.0.0.1:10080/mvcc/index/test/t1/idx/1\?a\=A
$curl "http://127.0.0.1:10080/mvcc/index/test/t1/idx/1?a=A"
{
"info": {
"writes": [
Expand All @@ -411,17 +411,17 @@ timezone.*
*Hint: On a partitioned table, use the `table(partition)` pattern as the table name, `t1(p1)` for example:*

```shell
$curl http://127.0.0.1:10080/mvcc/index/test/t1(p1)/idx/1\?a\=A
$curl "http://127.0.0.1:10080/mvcc/index/test/t1(p1)/idx/1?a=A"
```

If the handle is clustered, also specify the primary key column values in the query string

```shell
$curl http://{TiDBIP}:10080/mvcc/index/{db}/{table}/{index}?${c1}={v1}&${c2}=${v2}
$curl "http://{TiDBIP}:10080/mvcc/index/{db}/{table}/{index}?${c1}={v1}&${c2}=${v2}"
```

```shell
$curl http://127.0.0.1:10080/mvcc/index/test/t/idx\?a\=1.1\&b\=111\&c\=1
$curl "http://127.0.0.1:10080/mvcc/index/test/t/idx?a=1.1&b=111&c=1"
{
"key": "74800000000000003B5F69800000000000000203800000000000000105BFF199999999999A013131310000000000FA",
"region_id": 59,
Expand Down Expand Up @@ -582,7 +582,7 @@ timezone.*
27. Get count {number} TiDB DDL job history information, start with job {id}

```shell
curl http://{TIDBIP}:10080/ddl/history?start_job_id={id}&limit={number}
curl "http://{TIDBIP}:10080/ddl/history?start_job_id={id}&limit={number}"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are a lot of uses of "&" in this file so we'd better unify.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hawkingrei could you help take a look again?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other urls can be changed together? It's not very uniform

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@zimulala updated, ptal.

```

28. Download TiDB debug info
Expand Down