chore: bytebase/api-example to bytebase/example-api

tianzhou · tianzhou · commit d2b0b202ae14 · 2025-03-16T21:48:04.000+08:00
diff --git a/content/blog/bytebase-vs-cloudbeaver.md b/content/blog/bytebase-vs-cloudbeaver.md
@@ -152,7 +152,7 @@ On the other hand, the more common way to change the schema is to use **Schema E
 
 - **CloudBeaver**: Support [GraphQL](https://github.com/dbeaver/cloudbeaver/wiki/Server-API-explorer), while the doc is pretty light.
 
-- **Bytebase**: Support gRPC and HTTP/REST. Bytebase provides extensive [docs](/docs/api/overview/), [code samples](https://github.com/bytebase/api-example), and [tutorials](/tutorial/).
+- **Bytebase**: Support gRPC and HTTP/REST. Bytebase provides extensive [docs](/docs/api/overview/), [code samples](https://github.com/bytebase/example-api), and [tutorials](/tutorial/).
 
 ### GitOps
 
diff --git a/content/docs/api/sql-review.md b/content/docs/api/sql-review.md
@@ -19,7 +19,7 @@ Before you start, you should configure the [SQL Review Policy](/docs/sql-review/
 | Endpoint | [POST /v1/projects/-/releases:check](https://api.bytebase.com/#tag/releaseservice/POST/v1/projects/{project}/releases:check) |
 | Request  | https://api.bytebase.com/#model/checkreleaserequest                                                                          |
 | Response | https://api.bytebase.com/#model/checkreleaseresponse                                                                         |
-| Example  | https://github.com/bytebase/api-example/tree/main/sql-review#batch-api-recommended                                           |
+| Example  | https://github.com/bytebase/example-api/tree/main/sql-review#batch-api-recommended                                           |
 
 Batch API allows you to validate multiple statements across multiple databases in a single API call.
 
@@ -34,6 +34,6 @@ earlier files, the Batch API ensures each subsequent file is validated accuratel
 | Endpoint | [POST /v1/sql/check](https://api.bytebase.com/#tag/sqlservice/POST/v1/sql/check) |
 | Request  | https://api.bytebase.com/#model/checkrequest                                     |
 | Response | https://api.bytebase.com/#model/checkresponse                                    |
-| Example  | https://github.com/bytebase/api-example/tree/main/sql-review#simple-api          |
+| Example  | https://github.com/bytebase/example-api/tree/main/sql-review#simple-api          |
 
 Simple API allows you to validate a single statement against a single database.
diff --git a/content/docs/tutorials/api-audit-log.md b/content/docs/tutorials/api-audit-log.md
@@ -22,7 +22,7 @@ This tutorial will focus on fetch and filter audit log in Bytebase, it's OK if y
 
 <HintBlock type="info">
 
-This tutorial code repository is at https://github.com/bytebase/api-example/tree/main/audit-log
+This tutorial code repository is at https://github.com/bytebase/example-api/tree/main/audit-log
 
 </HintBlock>
 
@@ -42,7 +42,7 @@ This tutorial code repository is at https://github.com/bytebase/api-example/tree
 ## Run Demo
 
 1. Go to [Bytebase API Example
-   repo](https://github.com/bytebase/api-example) and clone it.
+   repo](https://github.com/bytebase/example-api) and clone it.
 
 1. Copy `env-template.local` to `.env.local`.Update the variables.
 
@@ -65,7 +65,7 @@ This tutorial code repository is at https://github.com/bytebase/api-example/tree
 
 ## Fetch and Filter Audit Log
 
-Let's dig into the [code](https://github.com/bytebase/api-example/tree/main/audit-log/src):
+Let's dig into the [code](https://github.com/bytebase/example-api/tree/main/audit-log/src):
 
 1. In `page.tsx`, we fetch all projects by calling the [/v1/projects](https://api.bytebase.com/#tag/projectservice/GET/v1/projects) API before any project selection.
 
diff --git a/content/docs/tutorials/api-issue.md b/content/docs/tutorials/api-issue.md
@@ -23,7 +23,7 @@ By following the step-by-step instructions provided, you will have the opportuni
 
 <HintBlock type="info">
 
-This tutorial code repository is at https://github.com/bytebase/api-example/issue-creation
+This tutorial code repository is at https://github.com/bytebase/example-api/issue-creation
 
 </HintBlock>
 
@@ -68,7 +68,7 @@ Below is an example app demonstrating the following APIs:
 ---
 
 1. Go to [Bytebase API Example
-   repo](https://github.com/bytebase/api-example) and clone it.
+   repo](https://github.com/bytebase/example-api) and clone it.
 
 1. Copy `env-template.local` to `.env.local`.Update the variables.
 
@@ -102,7 +102,7 @@ Below is an example app demonstrating the following APIs:
 1. Go back to the sample application, and click **Refresh status**. You'll see the status has changed from [OPEN] to [DONE].
    ![sample-done](/content/docs/tutorials/api-issue/sample-done.webp)
 
-1. For additional information about the example application, refer to the README in its corresponding [GitHub repository](https://github.com/bytebase/api-example/).
+1. For additional information about the example application, refer to the README in its corresponding [GitHub repository](https://github.com/bytebase/example-api/).
 
 ## Summary
 
diff --git a/content/docs/tutorials/api-sql-review-policy.md b/content/docs/tutorials/api-sql-review-policy.md
@@ -11,7 +11,7 @@ description: 'Learn how to use the Bytebase API to configure SQL review rules in
 
 <IncludeBlock url="/docs/share/tutorials/api-preface"></IncludeBlock>
 
-This tutorial will guide you through configuring SQL review rules using the Bytebase API. This approach allows you to manage SQL review rules as code within your repository, enabling DBAs or platform engineering teams to apply them to Bytebase as needed. The tutorial repository is at https://github.com/bytebase/api-example/tree/main/sql-review.
+This tutorial will guide you through configuring SQL review rules using the Bytebase API. This approach allows you to manage SQL review rules as code within your repository, enabling DBAs or platform engineering teams to apply them to Bytebase as needed. The tutorial repository is at https://github.com/bytebase/example-api/tree/main/sql-review.
 
 This is the 4th part of tutorial series of SQL Review:
 
@@ -36,7 +36,7 @@ This is the 4th part of tutorial series of SQL Review:
 
 ## Obtain the Access Token
 
-1. Go to [Bytebase API Example repo](https://github.com/bytebase/api-example) and clone it.
+1. Go to [Bytebase API Example repo](https://github.com/bytebase/example-api) and clone it.
 
 1. Navigate to the `sql-review` subfolder and follow the instructions in the `README.md` file of the example code repository to execute the scripts.
 1. Replace `bytebase_url`, `bytebase_account`, and `bytebase_password` in the commands below with your own values, then run them to obtain a `bytebase_token` in your terminal.
diff --git a/content/docs/tutorials/api-user-database-permission.md b/content/docs/tutorials/api-user-database-permission.md
@@ -23,7 +23,7 @@ By following this guide, you'll learn how to:
 
 <HintBlock type="info">
 
-This tutorial code repository is at https://github.com/bytebase/api-example/tree/main/permission-check
+This tutorial code repository is at https://github.com/bytebase/example-api/tree/main/permission-check
 
 </HintBlock>
 
@@ -43,7 +43,7 @@ This tutorial code repository is at https://github.com/bytebase/api-example/tree
 ## Run Demo
 
 1. Go to [Bytebase API Example
-   repo](https://github.com/bytebase/api-example) and clone it.
+   repo](https://github.com/bytebase/example-api) and clone it.
 
 1. Copy `env-template.local` to `.env.local`.Update the variables.
 
diff --git a/content/docs/tutorials/data-classification.md b/content/docs/tutorials/data-classification.md
@@ -20,7 +20,7 @@ By the end of this tutorial, you will have accomplished the following:
 ## Prerequisites
 
 - Docker installed
-- Download the [api-example repository](https://github.com/bytebase/api-example), you'll only need `data-classification` folder for this tutorial
+- Download the [api-example repository](https://github.com/bytebase/example-api), you'll only need `data-classification` folder for this tutorial
 
 ## Overview
 
@@ -67,7 +67,7 @@ There are two ways to configure the data masking based on the classification lev
 
 #### API
 
-1. Find the [data masking configuration file](https://github.com/bytebase/api-example/blob/main/data-security/masking/global-masking-rule.json) within the `data-security` repository.
+1. Find the [data masking configuration file](https://github.com/bytebase/example-api/blob/main/data-security/masking/global-masking-rule.json) within the `data-security` repository.
 1. Generate the token for the service account user:
 
    ```bash
diff --git a/content/docs/tutorials/database-change-management-with-jira-automated.md b/content/docs/tutorials/database-change-management-with-jira-automated.md
@@ -24,7 +24,7 @@ Here is what you will achieve by the end of this tutorial:
 - A Jira workspace
 - A Bytebase instance
 - [Manual Database Change with Jira](/docs/tutorials/database-change-management-with-jira-manual) completed
-- Download the [api-example repository](https://github.com/bytebase/api-example), you'll only need `jira` folder for this tutorial
+- Download the [api-example repository](https://github.com/bytebase/example-api), you'll only need `jira` folder for this tutorial
 
 ## Workflow Overview
 
diff --git a/content/docs/tutorials/embed-sql-editor.md b/content/docs/tutorials/embed-sql-editor.md
@@ -25,7 +25,7 @@ By the end of this tutorial, you will have achieved the following:
 
 - A Google Cloud account
 - Docker installed
-- Download the [api-example repository](https://github.com/bytebase/api-example), you'll only need `sql-editor` folder for this tutorial
+- Download the [api-example repository](https://github.com/bytebase/example-api), you'll only need `sql-editor` folder for this tutorial
 
 ## Overview
 
diff --git a/content/docs/tutorials/sql-review-api.md b/content/docs/tutorials/sql-review-api.md
@@ -31,7 +31,7 @@ If you want to test the SQL Review API locally, you may need to configure ngrok.
 
 ## API Examples
 
-You may call [Bytebase API](/docs/api/sql-review/) in your internal portal or GitHub Actions to trigger SQL Review. Check out https://github.com/bytebase/api-example/tree/main/issue-creation
+You may call [Bytebase API](/docs/api/sql-review/) in your internal portal or GitHub Actions to trigger SQL Review. Check out https://github.com/bytebase/example-api/tree/main/issue-creation
 
 ![bb-api](/content/docs/tutorials/sql-review-api/bb-api.webp)
 
