Skip to content

Commit 070d7c8

Browse files
update
1 parent fb9b9fa commit 070d7c8

File tree

1 file changed

+25
-9
lines changed

1 file changed

+25
-9
lines changed

docs/changelog/bytebase-3-17-0.mdx

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -83,15 +83,31 @@ import InstallUpgrade from '/snippets/install/install-upgrade.mdx';
8383

8484
### API Breaking Changes
8585

86-
| Change | Affected Routes | Before | After |
87-
| -- | -- | -- | -- |
88-
| Worksheet API path | All worksheet endpoints | `/v1/worksheets` | `/v1/projects/{id}/worksheets` |
89-
| ListDatabases scope | `GET /v1/{parent=workspaces/*}/databases` | `/v1/workspaces/-/databases` | `/v1/workspaces/{id}/databases` |
90-
| Branding logo | `GET/PATCH /v1/workspaces/{id}` | `branding_logo` in workspace profile setting | `logo` field on workspace message |
91-
| Issue type enum | `POST /v1/{parent=projects/*}/issues`, `GET /v1/{parent=projects/*}/issues`, `POST /v1/{parent=projects/*}/issues:search` | `GRANT_REQUEST` | `ROLE_GRANT` |
92-
| Subscription API | `PATCH /v1/subscription` | `PATCH /v1/subscription` | `PATCH /v1/subscription/license` (deprecated, use `UploadLicense`) |
93-
| Data source ID | `POST /v1/{name=instances/*/databases/*}:query`, `POST /v1/{name=instances/*/databases/*}:export` | Required explicit `data_source_id` | Auto-resolved server-side; at most one read-only data source per instance (extra removed during migration) |
94-
| Classification level | `GET/PATCH /v1/settings/{name}`, `POST /v1/queryHistories:search` | `string` type with `description` field | `int` type, `description` removed |
86+
**1. Worksheet API moves to project scope:**
87+
88+
| Method | Before | After |
89+
| -- | -- | -- |
90+
| List | `/v1/worksheets` | `/v1/{parent=projects/*}/worksheets` |
91+
| Get | `/v1/{name=worksheets/*}` | `/v1/{name=projects/*/worksheets/*}` |
92+
| Create | `/v1/worksheets` | `/v1/{parent=projects/*}/worksheets` |
93+
| Update | `/v1/{worksheet.name=worksheets/*}` | `/v1/{worksheet.name=projects/*/worksheets/*}` |
94+
| Delete | `/v1/{name=worksheets/*}` | `/v1/{name=projects/*/worksheets/*}` |
95+
96+
**2. APIs that no longer accept** `workspaces/-` (must use `workspaces/{id}`):
97+
98+
| Service | Affected Operations |
99+
| -- | -- |
100+
| DatabaseService | `ListDatabases` |
101+
102+
**3. Other breaking changes:**
103+
104+
| Change | Affected Routes | Details |
105+
| -- | -- | -- |
106+
| Branding logo | `GET/PATCH /v1/workspaces/{id}` | `branding_logo` removed from workspace profile setting; use `logo` field on workspace message |
107+
| Issue type enum | `POST /v1/{parent=projects/*}/issues`, `GET /v1/{parent=projects/*}/issues`, `POST /v1/{parent=projects/*}/issues:search` | `GRANT_REQUEST` renamed to `ROLE_GRANT` |
108+
| Subscription API | `PATCH /v1/subscription` | Deprecated; use `PATCH /v1/subscription/license` (`UploadLicense`) |
109+
| Data source ID | `POST /v1/{name=instances/*/databases/*}:query`, `POST /v1/{name=instances/*/databases/*}:export` | `data_source_id` auto-resolved server-side; at most one read-only data source per instance (extra removed during migration) |
110+
| Classification level | `GET/PATCH /v1/settings/{name}`, `POST /v1/queryHistories:search` | Level type changed from `string` to `int`; `description` field removed |
95111

96112
### CEL Filter Syntax Change
97113

0 commit comments

Comments
 (0)