LLM/opencode
1
0
Fork 0
mirror of https://github.com/anomalyco/opencode.git synced 2026-05-22 20:05:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(effect): require openapi and sdk diff checks

Browse Source 
Add an explicit migration step to compare generated OpenAPI and SDK output after each HttpApi slice so we record whether any diff is a real contract change or only acceptable schema churn.
This commit is contained in:
Kit Langton
2026-04-14 13:00:41 -04:00
parent 8ca54d8110
commit 185a0f9818
1 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
packages/opencode/specs/effect/http-api.md
View File

@@ -197,7 +197,8 @@ Use the same sequence for each route group.
5. Implement handlers by yielding the existing service from context.
6. Mount the new surface in parallel under an experimental prefix.
7. Add one end-to-end test and one OpenAPI-focused test.
8. Compare ergonomics before migrating the next endpoint.
8. Regenerate OpenAPI and SDK output and inspect the diff.
9. Compare ergonomics before migrating the next endpoint.
Rule of thumb:
@@ -260,6 +261,9 @@ Each route-group spike should follow the same shape.
- call the experimental endpoints
- assert that the service behavior is unchanged
- assert that the generated OpenAPI contains the migrated paths and schemas
- compare generated OpenAPI before vs after for the migrated routes
- regenerate the SDK and check whether the generated diff reflects a real contract change or only naming / component churn
- prefer no meaningful SDK or OpenAPI contract diff for the migrated endpoints; if there is churn, document exactly why it is acceptable
## Boundary composition