Skip to content

Commit 87850d9

Browse files
committed
docs: add SQL Editor api
1 parent 5ac9e94 commit 87850d9

File tree

3 files changed

+18
-6
lines changed

3 files changed

+18
-6
lines changed

content/docs/_layout.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -247,12 +247,14 @@ expand_section_list: ['Self-host']
247247

248248
### [Issue](/api/issue)
249249

250-
### [Permission](/api/permission)
250+
### [SQL Editor](/api/sql-editor)
251251

252-
### [Audit Log](/api/audit-log)
252+
### [Permission](/api/permission)
253253

254254
### [Data Classification](/api/data-classification)
255255

256+
### [Audit Log](/api/audit-log)
257+
256258
### [External Approval](/api/external-approval)
257259

258260
## Integrations

content/docs/api/overview.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,14 @@
22
title: Overview
33
---
44

5-
<TutorialBlock url="/docs/tutorials/api-issue" title="Deploy Schema Migration with Bytebase API" />
5+
Bytebase provides [gRPC](https://github.com/bytebase/bytebase/tree/main/proto/gen/grpc-doc/v1) and [RESTful HTTP API](https://api.bytebase.com).
66

77
You can manipulate every aspect of Bytebase via API. In fact, the Bytebase UI console is built on the
8-
same API. You can use Bytebase as a headless database deployment backend and integrate it with your own
8+
same API. You can use Bytebase as a headless database workflow backend and integrate it with your own
99
internal developer platform.
1010

11-
Bytebase API is gRPC-based ([spec](https://github.com/bytebase/bytebase/tree/main/proto/gen/grpc-doc/v1)).
11+
- [SQL lint](/docs/api/sql-review/)
1212

13-
Bytebase also provides [RESTful HTTP API](https://api.bytebase.com). Internally, it uses [grpc-gateway](https://github.com/grpc-ecosystem/grpc-gateway) to transcode HTTP API to gRPC.
13+
- [Database change deployment](/docs/api/issue/)
14+
15+
- [Embedded SQL Editor](/docs/api/sql-editor/)

content/docs/api/sql-editor.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: SQL Editor
3+
---
4+
5+
<TutorialBlock url="/docs/tutorials/embed-sql-editor/" title="Embed SQL Editor in Your Internal Web Portal" />
6+
7+
You can configure [database permissions](/api/permission) and masking policies via API and embed
8+
Bytebase SQL Editor into your own internal web portal.

0 commit comments

Comments
 (0)