Task 03 API Change Impact Analysis Lab Guide
📥 Lab input
- •
day4_api_change_request.md(change request)
💾 Lab output
- •
change-impact-report.md(change impact analysis)
1. Story and lab background
As the service takes off, a new business spec change comes down: "Before, we sent the payment amount right when the booking was created. For payment transparency, remove the payment amount field when creating a booking, and split the flow so the amount is entered in a separate payment step after the booking is created."
The dev team quickly added an is_approved column and a waiting-for-approval state to the DB's Reservations table, but this important structural change was never shared in the front-end UI doc or plan. As a result, many failures from missing API parameters showed up during QA.
In this lab, you'll learn a workflow: when the schema changes, use Codex to automatically analyze all the API endpoints and screen design changes affected in a chain, and write a report to share with teammates.
2. Learning goals
- Trace the chain effects of a data structure change (Schema Change) on the system.
- Identify and map the front-end UI docs and screens that need updating right away because of the change.
- Independently produce a sharing report summarizing the changes and impact for teammates.
🛠️ Follow-along lab guide
- Create the lab file: press the download button below to download
day4_api_change_request.mdand save it in theautomation/folder. - Hand the analysis to Codex: send the **Codex request prompt** below in the Codex Client prompt box and build.
- Check the impact report: confirm the report properly covers the more detailed DB status (Wait Approve), API Response field changes, and the new payment API button and status panel requirements.
Download lab materials
Codex request prompt
Task 03 Prompt
Analyze the provided API change request (day4_api_change_request.md), list the other system areas and docs affected when the booking request API changes, and write an API impact analysis teammates can act on right away.
4. Example output
Codex accurately traces the revision needs across all downstream modules based on the schema change.
| Impact area | Detailed change | Risk level | Docs and specs to update |
|---|---|---|---|
| API spec | More detailed status codes in the Reservations table (add WAIT_APPROVE state) | High | Update the API spec doc and DDL queries |
| Front-end UI | Remove or move the payment amount field on the booking request form | High | Update the related APIs in api-specification.md |
| New payment API | Add a disabled state to the 'Pay' button on the booking detail screen and add a 'waiting for expert approval' panel | High | Update the member booking screen plan & UI components |