Task 02 API Mismatch Detection Lab Guide
📥 Lab input
- •
day4_api_specification_v1.md(API spec draft)
💾 Lab output
- •
project-glossary.md(standard term dictionary)
1. Story and lab background
Late in the project, a strange conversation happens in a bug review meeting. The planner says "The rating doesn't show on the expert list screen," the API developer says "The star_rating field for the expert list card isn't in the API Response spec," and the front-end developer says "The expert's approve button calls an API that doesn't exist."
When the plan, screen design, API spec and DB tables don't line up like this, communication costs between developers grow and it breeds code rework.
In this lab, you'll learn to use Codex to survey scattered terms across all project docs and build a standard term dictionary (Glossary) that runs from planning all the way to DB variable names.
2. Learning goals
- Identify how domain terms are scattered across docs and design specs.
- Define the detection areas and English abbreviations (domain standard names) for the project.
- Define a standard term dictionary that planners, developers and designers all follow.
- Use AI to map legacy words to variable names and data types.
🛠️ Follow-along lab guide
- Create lab files: press the download buttons below to download the planning docs and API spec draft, and save them in the
automation/folder. - Hand standardization to Codex: send the **Codex request prompt** below in the Codex Client prompt box and build.
- Review the report: check that mismatched items are correctly mapped to a detection area, English standard name and recommended action.
Download lab materials (3 files)
Codex request prompt
Task 02 Prompt
Cross-check the provided day4_requirements.md, day4_screen_definition.md and day4_api_specification_v1.md, find API endpoints and fields that don't match or are missing from the planning requirements or screen UI design, and write a review report.
4. Example output
Codex analyzes the terms together and produces a normalized master dictionary like this.
| Detection area | Detailed mismatch / gap | Data type | Mixed words in use | Recommended action |
|---|---|---|---|---|
| Missing field | The rating (star_rating) field on the expert list card UI is missing from the API Response spec | VARCHAR(50) | High — the rating (star_rating) field on the expert list card UI is missing from the API Response spec | Add star_rating to the GET /api/v1/experts API response data |
| Missing Endpoint | The plan describes counselor booking approval, but the back-end API spec has no API to change approval status | VARCHAR(50) | Critical (High) — the plan describes counselor booking approval, but the back-end API spec has no API to change approval status | Design a new PATCH /api/v1/reservations/{id}/status API |
| Session booking | Reservation | VARCHAR(50) | booking, request, Book, Reservation | reservation_id |
| Booking status | ReservationStatus | VARCHAR(20) | status, type, Step, Status | res_status |