Skip to content

Commit 645e6cd

Browse files
committed
refactor: fix typo 0.1 -> 1.0 and improve inter-consistency between two migration files
1 parent 9f2e788 commit 645e6cd

2 files changed

Lines changed: 8 additions & 5 deletions

File tree

docs/migrations/v0_3_to_v1_0/database/simple_migration.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ pip install "a2a-sdk[db-cli]"
2424
## 🚀 Migration Steps
2525

2626
### Step 1: Apply Schema Updates
27-
Run the `a2a-db` tool to update your tables.
27+
28+
Run the `a2a-db` migration tool to update your tables. This adds new columns (`owner`, `protocol_version`, `last_updated`) while leaving existing v0.3 data intact.
2829

2930
```bash
3031
# Run migration against your target database
@@ -38,9 +39,10 @@ uv run a2a-db --database-url "your-database-url"
3839
> [!NOTE]
3940
> All new columns are nullable or have default values.
4041
>
41-
> Protocol v1.0 is designed to be backward compatible by default. After this step, your new v0.1 code will be able to read existing v0.3 entries from the database using a built-in legacy parser.
42+
> Protocol v1.0 is designed to be backward compatible by default. After this step, your new v1.0 code will be able to read existing v0.3 entries from the database using a built-in legacy parser.
4243
4344
### Step 2: Verify the Migration
45+
4446
Confirm the schema is at the correct version:
4547

4648
```bash
@@ -49,6 +51,7 @@ uv run a2a-db current
4951
The output should show the latest revision ID (e.g., `38ce57e08137`).
5052

5153
### Step 3: Update Your Application Code
54+
5255
Upgrade your application to use the v1.0 SDK.
5356

5457
---

docs/migrations/v0_3_to_v1_0/database/zero_downtime.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ pip install "a2a-sdk[db-cli]"
2727

2828
Zero-downtime migration requires an "Expand, Migrate, Contract" pattern. It means we first expand the schema, then migrate the code to coexist with the old format, and finally transition fully to the new v1.0 standards.
2929

30-
### Step 1: Expand Schema
30+
### Step 1: Apply Schema Updates
3131

32-
Apply the v1.0 schema updates to your database using the `a2a-db` migration tool. This adds new columns (`owner`, `protocol_version`, `last_updated`) while leaving existing v0.3 data intact.
32+
Run the `a2a-db` migration tool to update your tables. This adds new columns (`owner`, `protocol_version`, `last_updated`) while leaving existing v0.3 data intact.
3333

3434
```bash
3535
# Run migration against your target database
@@ -43,7 +43,7 @@ uv run a2a-db --database-url "your-database-url"
4343
> [!NOTE]
4444
> All new columns are nullable or have default values. Your existing v0.3 code will continue to work normally after this step is completed.
4545
>
46-
> Protocol v1.0 is designed to be backward compatible by default. After this step, your new v0.1 code will be able to read existing v0.3 entries from the database using a built-in legacy parser.
46+
> Protocol v1.0 is designed to be backward compatible by default. After this step, your new v1.0 code will be able to read existing v0.3 entries from the database using a built-in legacy parser.
4747
4848
#### ✅ How to Verify
4949
Run `uv run a2a-db current` to ensure the migration was applied successfully.

0 commit comments

Comments
 (0)