Skip to content

fix(api): align OpenAPI contract with handlers - #3436

Open
buttercannfly wants to merge 2 commits into
e2b-dev:mainfrom
buttercannfly:codex/fix-openapi-health
Open

fix(api): align OpenAPI contract with handlers#3436
buttercannfly wants to merge 2 commits into
e2b-dev:mainfrom
buttercannfly:codex/fix-openapi-health

Conversation

@buttercannfly

@buttercannfly buttercannfly commented Jul 29, 2026

Copy link
Copy Markdown

Summary

  • align documented statuses and response media types with API handlers and shared helpers
  • document authorization, rate-limit, request-size, and generated request-binding responses across all affected routes
  • tighten request schemas to match runtime validation and regenerate the API clients/server bindings
  • add regression tests that traverse generated routes and handler helper calls to detect future contract drift

Validation

  • go test ./packages/api/internal/api -count=1
  • go test ./packages/api/internal/handlers -run TestOpenAPIIncludesHandlerContract -count=1
  • go test ./packages/api/internal/middleware/ratelimit -run '^TestMiddleware_' -count=1
  • go test ./tests/integration/internal/api -count=1
  • npx --yes @redocly/cli lint spec/openapi.yml
  • both generators are idempotent and git diff --check passes

@cla-bot

cla-bot Bot commented Jul 29, 2026

Copy link
Copy Markdown

We require contributors to sign our Contributor License Agreement, and we don't have @buttercannfly on file. You can sign our CLA at https://e2b.dev/docs/cla . Once you've signed, post a comment here that says '@cla-bot check'

@buttercannfly buttercannfly changed the title fix(api): align health endpoint OpenAPI responses fix(api): align OpenAPI contract with handlers Jul 29, 2026
@buttercannfly buttercannfly reopened this Jul 29, 2026
@cla-bot

cla-bot Bot commented Jul 29, 2026

Copy link
Copy Markdown

We require contributors to sign our Contributor License Agreement, and we don't have @buttercannfly on file. You can sign our CLA at https://e2b.dev/docs/cla . Once you've signed, post a comment here that says '@cla-bot check'

@buttercannfly

Copy link
Copy Markdown
Author

@cla-bot check

@cla-bot cla-bot Bot added the cla-signed label Jul 29, 2026
@cla-bot

cla-bot Bot commented Jul 29, 2026

Copy link
Copy Markdown

The cla-bot has been summoned, and re-checked this pull request!

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