You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
tidb-cloud: fix code fences, duplicated text, and wrong values in TiDB Cloud docs (#24487) - #24561
Fix code fences, duplicated text, and wrong values in the TiDB Cloud docs. These errors were found while reviewing the English docs for issues that affect the Japanese translation. Each fix is shown below; the same wrong text was also searched for in the rest of the docs.
File
Before
After
tidb-cloud/dedicated-external-storage.md
A JSON code block opens with 4 backticks and closes with 3
Open it with 3 backticks
releases/release-7.6.0.md
A SQL code block opens with 3 backticks and closes with 4
Close it with 3 backticks
tidb-cloud/set-up-private-endpoint-connections.md
"Go to VPC > Endpoints. To do so, go to VPC > Endpoints, …"
Remove the duplicated first sentence
tidb-cloud/sql-concepts.md
The "Since the value of AUTO_RANDOM is random and unique, …" sentence appears twice in a row
Keep it once
tidb-cloud/terraform-get-tidbcloud-provider.md
The example for "By setting sync to true" does not set sync
The comment says "b2.…:9095" while the configuration line below it is for b3
"b3.…:9095"
tidb-cloud/use-chat2query-api.md
HTTP method DEL
DELETE
tidb-cloud/migrate-from-op-tidb.md
After SET GLOBAL tidb_gc_enable = TRUE, "1 indicates that GC is disabled"
"enabled"
tidb-cloud/tidb-cloud-password-authentication.md
Note: "Google SSO or GitHub SSO … managed by Google or GitHub"
Include Microsoft, as in the rest of the page
Which TiDB version(s) do your changes apply to? (Required)
Tips for choosing the affected version(s):
By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.
This pull-request has been approved by: Once this PR has been reviewed and has the lgtm label, please assign oreoxmt for approval. For more information see the Code Review Process. Please ensure that each of them provides their approval before proceeding.
The full list of commands accepted by this bot can be found here.
Details
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment
ti-chi-botBot
added
size/XL
Denotes a PR that changes 500-999 lines, ignoring generated files.
and removed
size/S
Denotes a PR that changes 10-29 lines, ignoring generated files.
labels
Oct 27, 2026
The change adds a Chat2Query API guide with endpoint workflows and examples. It also corrects examples, instructions, and descriptions in existing release and TiDB Cloud documentation.
Changes: Chat2Query API guide
Layer / File(s)
Summary
Access and endpoint overview tidb-cloud/use-chat2query-api.md
The guide describes API availability, Data App and API-key setup, request limits, and v3, v2, and deprecated v1 endpoints.
The guide documents v1 restrictions, request parameters, examples, and related documentation links.
Existing documentation updates
Layer / File(s)
Summary
Example values and configuration tidb-cloud/migrate-from-op-tidb.md, tidb-cloud/serverless-private-link-connection-to-self-hosted-kafka-in-alicloud.md, tidb-cloud/serverless-private-link-connection-to-self-hosted-kafka-in-aws.md, tidb-cloud/setup-aws-self-hosted-kafka-private-link-service.md, tidb-cloud/terraform-get-tidbcloud-provider.md
Examples correct the meaning of GC output 1, use broker ID b3 for the listed AZ3 listeners, and add sync = true to the Terraform provider configuration.
Instructions and descriptions tidb-cloud/set-up-private-endpoint-connections.md, tidb-cloud/tidb-cloud-password-authentication.md, tidb-cloud/sql-concepts.md
The documentation updates endpoint security-group instructions, adds Microsoft SSO to the password guidance, and shortens the AUTO_RANDOM description.
This documentation change fixes several existing errors and adds a Chat2Query API guide. The guide's job-status curl example contains a stray backtick that breaks the copied command. Its polling instructions and response example also have small inaccuracies. These are quick documentation edits and do not affect product behavior, so fix them before or soon after merge.
Pre-merge checks: 5
Check name
Status
Explanation
Title check
The title names the main change: fixing code fences, duplicated text, and wrong values in TiDB Cloud docs. The changeset contains exactly these kinds of fixes across the listed files. The title is spe…
Description check
The description follows the template. It states what changed in a table with before and after entries for each file. It marks the affected versions (master and v8.5). It fills in the AI agent involvem…
Docstring Coverage
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Documentation-only edits and deletions within survi…
Linked Issues check
Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check
Check skipped because no linked issues were found for this pull request.
Full details: Title check
Explanation
The title names the main change: fixing code fences, duplicated text, and wrong values in TiDB Cloud docs. The changeset contains exactly these kinds of fixes across the listed files. The title is specific enough for a reviewer scanning history, although it is slightly long at 90 characters.
Full details: Description check
Explanation
The description follows the template. It states what changed in a table with before and after entries for each file. It marks the affected versions (master and v8.5). It fills in the AI agent involvement checkbox and the cherry-pick source. The contributor checklist and related-PR links are left unfilled. These are non-critical for an automated cherry-pick, so the description is mostly complete.
Full details: Docstring Coverage
Explanation
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (11 skipped: 11 unsupported.)
Finishing Touches: 💡 1
🧪 Generate unit tests (beta)
Create a new PR
🛠️ Fix failing CI checks: 💡
Commit to this branch
Create a new PR
Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
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.
Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 2 remain after this review.
The reason will be displayed to describe this comment to others. Learn more.
Minor · Maintainability & Code Quality · Quick win
Correct the endpoint-list grammar.
Use start with instead of starting with. Add a space before (recommended).
Suggested replacement
--- "a/tidb-cloud/use-chat2query-api.md"+++ "b/tidb-cloud/use-chat2query-api.md"@@ -69,8 +69,8 @@
In each Chat2Query Data App, you can find the following endpoints:
-- Chat2Query v3 endpoints: the endpoints whose names starting with `/v3`, such as `/v3/dataSummaries` and `/v3/chat2data`(recommended)-- Chat2Query v2 endpoints: the endpoints whose names starting with `/v2`, such as `/v2/dataSummaries` and `/v2/chat2data`+- Chat2Query v3 endpoints: the endpoints whose names start with `/v3`, such as `/v3/dataSummaries` and `/v3/chat2data` (recommended)+- Chat2Query v2 endpoints: the endpoints whose names start with `/v2`, such as `/v2/dataSummaries` and `/v2/chat2data`
- Chat2Query v1 endpoint: `/v1/chat2data`(deprecated)
> **Tip:**
As per path instructions, this is an exact replacement for contiguous Markdown lines.
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.
Suggested change
- Chat2Query v3 endpoints: the endpoints whose names starting with `/v3`, such as `/v3/dataSummaries` and `/v3/chat2data`(recommended)
- Chat2Query v2 endpoints: the endpoints whose names starting with `/v2`, such as `/v2/dataSummaries` and `/v2/chat2data`
- Chat2Query v3 endpoints: the endpoints whose names start with `/v3`, such as `/v3/dataSummaries` and `/v3/chat2data`(recommended)
- Chat2Query v2 endpoints: the endpoints whose names start with `/v2`, such as `/v2/dataSummaries` and `/v2/chat2data`
> Compared with `/v1/chat2data`, `/v3/chat2data` and `/v2/chat2data` requires you to analyze your database first by calling `/v3/dataSummaries` or `/v2/dataSummaries`. Consequently, the results returned by `/v3/chat2data` and `/v2/chat2data` are generally more accurate.
The reason will be displayed to describe this comment to others. Learn more.
Minor · Maintainability & Code Quality · Quick win
Fix the plural agreement in the endpoint comparison.
/v3/chat2data and /v2/chat2data are plural, so use require instead of requires.
Suggested replacement
-Compared with `/v1/chat2data`, `/v3/chat2data` and `/v2/chat2data` requires you to analyze your database first by calling `/v3/dataSummaries` or `/v2/dataSummaries`. Consequently, the results returned by `/v3/chat2data` and `/v2/chat2data` are generally more accurate.+Compared with `/v1/chat2data`, `/v3/chat2data` and `/v2/chat2data` require you to analyze your database first by calling `/v3/dataSummaries` or `/v2/dataSummaries`. Consequently, the results returned by `/v3/chat2data` and `/v2/chat2data` are generally more accurate.
As per path instructions, this is an exact replacement for the contiguous Markdown line.
| PUT | `/v3/dataSummaries/{data_summary_id}` | This endpoint updates a specific data summary. |
| PUT | `/v3/dataSummaries/{data_summary_id}/tables/{table_name}` | This endpoint updates the description of a specific table in a specific data summary. |
| PUT | `/v3/dataSummaries/{data_summary_id}/tables/{table_name}/columns` | This endpoint updates the description of columns for a specific table in a specific data summary. |
| POST | `/v3/knowledgeBases` | This endpoint creates a new knowledge base. For more information about the usage of knowledge base related endpoints, see [Use knowledge bases](/tidb-cloud/use-chat2query-knowledge.md). |
The reason will be displayed to describe this comment to others. Learn more.
Minor · Maintainability & Code Quality · Quick win
Hyphenate the compound adjective.
Use knowledge-base-related before endpoints.
Suggested replacement
--- "a/tidb-cloud/use-chat2query-api.md"+++ "b/tidb-cloud/use-chat2query-api.md"@@ -107,7 +107,7 @@
| PUT | `/v3/dataSummaries/{data_summary_id}` | This endpoint updates a specific data summary. |
| PUT | `/v3/dataSummaries/{data_summary_id}/tables/{table_name}` | This endpoint updates the description of a specific table in a specific data summary. |
| PUT | `/v3/dataSummaries/{data_summary_id}/tables/{table_name}/columns` | This endpoint updates the description of columns for a specific table in a specific data summary. |
-| POST | `/v3/knowledgeBases` | This endpoint creates a new knowledge base. For more information about the usage of knowledge base related endpoints, see [Use knowledge bases](/tidb-cloud/use-chat2query-knowledge.md). |+| POST | `/v3/knowledgeBases` | This endpoint creates a new knowledge base. For more information about the usage of knowledge-base-related endpoints, see [Use knowledge bases](/tidb-cloud/use-chat2query-knowledge.md). |
| GET | `/v3/knowledgeBases` | This endpoint retrieves all knowledge bases. |
| GET | `/v3/knowledgeBases/{knowledge_base_id}` | This endpoint retrieves a specific knowledge base. |
| PUT | `/v3/knowledgeBases/{knowledge_base_id}` | This endpoint updates a specific knowledge base. |
Static analysis reports this compound-adjective issue. As per path instructions, this is an exact replacement for the contiguous Markdown line.
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.
Suggested change
| POST |`/v3/knowledgeBases`| This endpoint creates a new knowledge base. For more information about the usage of knowledgebaserelated endpoints, see [Use knowledge bases](/tidb-cloud/use-chat2query-knowledge.md).|
| POST |`/v3/knowledgeBases`| This endpoint creates a new knowledge base. For more information about the usage of knowledge-base-related endpoints, see [Use knowledge bases](/tidb-cloud/use-chat2query-knowledge.md). |
Tools
LanguageTool
[grammar] ~110-~110: Use a hyphen to join words.
Context: ...mation about the usage of knowledge base related endpoints, see [Use knowledge ba...
| POST | `/v2/dataSummaries` | This endpoint generates a data summary for your database schema, table schema, and column schema using artificial intelligence. |
| GET | `/v2/dataSummaries` | This endpoint retrieves all data summaries. |
| POST | `/v2/chat2data` | This endpoint enables you to generate and execute SQL statements using artificial intelligence by providing the data summary ID and instructions. |
| GET | `/v2/jobs/{job_id}` | This endpoint enables you to query the status of a specific data summary generation job. |
The reason will be displayed to describe this comment to others. Learn more.
Minor · Functional Correctness · Quick win
Describe /v2/jobs/{job_id} as a general job-status endpoint.
The guide later uses this endpoint to poll /v3/chat2data jobs. The current description incorrectly limits it to data-summary generation jobs.
Suggested replacement
--- "a/tidb-cloud/use-chat2query-api.md"+++ "b/tidb-cloud/use-chat2query-api.md"@@ -127,7 +127,7 @@
| POST | `/v2/dataSummaries` | This endpoint generates a data summary for your database schema, table schema, and column schema using artificial intelligence. |
| GET | `/v2/dataSummaries` | This endpoint retrieves all data summaries. |
| POST | `/v2/chat2data` | This endpoint enables you to generate and execute SQL statements using artificial intelligence by providing the data summary ID and instructions. |
-| GET | `/v2/jobs/{job_id}` | This endpoint enables you to query the status of a specific data summary generation job. |+| GET | `/v2/jobs/{job_id}` | This endpoint enables you to query the status of a specific job. |
The steps to call `/v3/chat2data` and `/v2/chat2data` are the same. The following sections take `/v3/chat2data` as an example to show how to call it.
As per path instructions, this is an exact replacement for the contiguous Markdown line.
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.
Suggested change
| GET |`/v2/jobs/{job_id}`| This endpoint enables you to query the status of a specific data summary generation job. |
| GET |`/v2/jobs/{job_id}`| This endpoint enables you to query the status of a specific job. |
The reason will be displayed to describe this comment to others. Learn more.
Major · Functional Correctness · Quick win
Remove the stray backtick from the job-status URL.
The backtick becomes part of the single-quoted URL. The copied command therefore does not call the documented /v2/jobs/{job_id} endpoint.
Suggested replacement
--- "a/tidb-cloud/use-chat2query-api.md"+++ "b/tidb-cloud/use-chat2query-api.md"@@ -175,7 +175,7 @@
To check the analysis status of your database, you can call the `/v2/jobs/{job_id}` endpoint as follows:
```bash
-curl --digest --user ${PUBLIC_KEY}:${PRIVATE_KEY} --request GET 'https://<region>.data.dev.tidbcloud.com/api/v1beta/app/chat2query-<ID>`/endpoint/v2/jobs/{job_id}'\+curl --digest --user ${PUBLIC_KEY}:${PRIVATE_KEY} --request GET 'https://<region>.data.dev.tidbcloud.com/api/v1beta/app/chat2query-<ID>/endpoint/v2/jobs/{job_id}'\
--header 'content-type: application/json'
```
As per path instructions, this is an exact replacement for the contiguous Markdown line.
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.
Suggested change
curl --digest --user ${PUBLIC_KEY}:${PRIVATE_KEY} --request GET 'https://<region>.data.dev.tidbcloud.com/api/v1beta/app/chat2query-<ID>`/endpoint/v2/jobs/{job_id}'\
curl --digest --user ${PUBLIC_KEY}:${PRIVATE_KEY} --request GET 'https://<region>.data.dev.tidbcloud.com/api/v1beta/app/chat2query-<ID>/endpoint/v2/jobs/{job_id}'\
If `"status"` is `"done"`, the full data summary is ready and you can now generate and execute SQL statements for this database by calling `/v3/chat2data`. Otherwise, you need to wait and check the analysis status later until it is done.
The reason will be displayed to describe this comment to others. Learn more.
Minor · Stability & Availability · Quick win
Stop polling after a failed job.
The current Otherwise branch treats failed jobs as pending jobs. Instruct readers to inspect reason when the job fails.
Suggested replacement
--- "a/tidb-cloud/use-chat2query-api.md"+++ "b/tidb-cloud/use-chat2query-api.md"@@ -194,7 +194,7 @@
}
```
-If `"status"` is `"done"`, the full data summary is ready and you can now generate and execute SQL statements for this database by calling `/v3/chat2data`. Otherwise, you need to wait and check the analysis status later until it is done.+If `"status"` is `"done"`, the full data summary is ready and you can now generate and execute SQL statements for this database by calling `/v3/chat2data`. If the job fails, stop polling and inspect `reason`. Otherwise, wait and check the analysis status later until it is done.
In the response, `DataSummaryObject` represents AI exploration information of the given database. The structure of `DataSummaryObject` is as follows:
As per path instructions, this is an exact replacement for the contiguous Markdown line.
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.
Suggested change
If `"status"` is `"done"`, the full data summary is ready and you can now generate and execute SQL statements for this database by calling `/v3/chat2data`. Otherwise, you need to wait and check the analysis status later until it is done.
If `"status"` is `"done"`, the full data summary is ready and you can now generate and execute SQL statements for this database by calling `/v3/chat2data`. If the job fails, stop polling and inspect `reason`. Otherwise, wait and check the analysis status later until it is done.
The reason will be displayed to describe this comment to others. Learn more.
Minor · Functional Correctness · Quick win
Add the missing commas in DataSummaryObject.
The JavaScript example is invalid at Lines 216, 224, and 228. Add commas after "referencing_table_column": "...", "name": "companies", and "name": "city" so readers can parse the documented response shape.
As per path instructions, this fix spans noncontiguous lines, so this comment lists all required edits instead of using one replacement block.
Also applies to: 224-224, 228-228
Source: Path instructions
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
ti-chi-bot
added
lgtm
needs-1-more-lgtm
ti-chi-bot
Bot
added
size/XL
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
This is an automated cherry-pick of #24487
What is changed, added, or deleted? (Required)
Fix code fences, duplicated text, and wrong values in the TiDB Cloud docs. These errors were found while reviewing the English docs for issues that affect the Japanese translation. Each fix is shown below; the same wrong text was also searched for in the rest of the docs.
AUTO_RANDOMis random and unique, …" sentence appears twice in a rowsynctotrue" does not setsyncsync = trueDELDELETESET GLOBAL tidb_gc_enable = TRUE, "1indicates that GC is disabled"Which TiDB version(s) do your changes apply to? (Required)
Tips for choosing the affected version(s):
By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.
For details, see tips for choosing the affected versions.
What is the related PR or file link(s)?
AI agent involvement
Do your changes match any of the following descriptions?
🤖 Generated with Claude Code
Summary by CodeRabbit