Skip to content

docs(httpapi): update migration spec to current state#25173

Merged
kitlangton merged 1 commit intodevfrom
kit/update-httpapi-migration-spec
Apr 30, 2026
Merged

docs(httpapi): update migration spec to current state#25173
kitlangton merged 1 commit intodevfrom
kit/update-httpapi-migration-spec

Conversation

@kitlangton
Copy link
Copy Markdown
Contributor

Summary

Docs-only update to packages/opencode/specs/effect/http-api.md so it reflects what's actually shipped:

  • Rewrite Current State to describe backend selection at server startup (server/backend.ts + server.ts), replacing the earlier in-Hono path-mounting bridge model.
  • Note that auth is centrally configured for the Effect backend via Effect `Config` (cee9610d2 refactor: use Effect config for HttpApi authorization, 3250b814c Fix HttpApi raw route authorization) rather than re-attached per route module.
  • Mark Phase 4 (OpenAPI/SDK generation from Effect) as implemented and opt-in (bun dev generate --httpapi, OPENCODE_SDK_OPENAPI=httpapi), and document the schema-shape gaps in the Effect-generated spec that block flipping the SDK generator default:
    • Branded-type pattern constraints not propagated (~169 missing).
    • Per-property description annotations not propagated (~107 missing).
    • Event.* / SyncEvent.* component-name dotted vs PascalCase divergence.
    • Component-deduper numbered duplicates (Session9, SyncEvent.session.updated.11).
  • Update Remaining PR Plan and bottom checklist:

Test plan

  • N/A — documentation only. Verify by reading the rendered diff.

Reflect the actual current architecture: backend selection at startup
(server/backend.ts + server.ts) replacing the earlier in-Hono bridge,
central Effect Config-based auth, and the implemented-but-opt-in
Effect HttpApi OpenAPI/SDK generation.

Document the remaining schema-shape gaps between hono-openapi output
and OpenApi.fromApi(PublicApi) output that block flipping the SDK
generator default.
@kitlangton kitlangton merged commit 76a0f0f into dev Apr 30, 2026
13 checks passed
@kitlangton kitlangton deleted the kit/update-httpapi-migration-spec branch April 30, 2026 22:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant