v1 getV1OpenApi
History for GET /v1/open-api.json
GET /v1/open-api.json — active. Recorded dates are not deployment dates.
2026-11-13 — Fix container startup after Aikido removal
Record: fix-container-startup; corrects remove-aikido-runtime.
- v1 GET /v1/open-api.json (getV1OpenApi; fixed; compatible)
- Before: After removal of the Aikido dependency, both Docker image startup commands still preloaded @aikidosec/firewall/instrument. Containers exited with MODULE_NOT_FOUND before listening, causing origin-backed requests to fail with gateway errors.
- After: Both Docker images start Node directly with source maps and dist/index.js, restoring origin availability without the removed preload. Existing route contracts, authentication, origin access controls, gateway quotas and custom anti-abuse behavior are preserved. Responses handled entirely at the gateway are unaffected.
- Client action: Retry requests that failed during the outage. No request format or authentication changes are required.
Verification: Dockerfile; Dockerfile-Google; package.json; pnpm release:check --base 8ef79d0; Live GET https://api.egdata.app/health returned 200 with healthy Redis and MongoDB after correcting the service startup arguments.; Live GET https://api.egdata.app/countries returned 200 after correcting the service startup arguments..
2026-11-13 — Enforce Free/Pro/Scale paid plans, server entitlements, period budgets, and Stripe billing
Record: paid-plans-and-billing.
- v1 GET /v1/open-api.json (getV1OpenApi; changed; compatible)
- Before: Version 1 gateway admission enforced Free/Pro/Enterprise RPM and monthly quota without server-side plan entitlement gates, Scale tier support, or paid billing-period allowances. Keys holding the
catalog:readscope bypassed granular scope restrictions, and ordinary admitted requests could clear active-minute expensive-policy counters in the same window. - After: Version 1 gateway now enforces Free (60 RPM when commercial limits are enabled, 100,000/month UTC), Pro (200 RPM, 300,000/billing period), Scale (600 RPM, 1,000,000/billing period), and explicit manual/enterprise grants, returning RFC 9457 Problem JSON
403 PLAN_ENTITLEMENT_REQUIREDand429 PERIOD_QUOTA_EXCEEDEDwhen exceeded, with idempotent5xxperiod-unit credit-back. Server-owned entitlements are checked prior to edge cache and quota admission,catalog:readwildcard bypass is removed, and active-minute expensive counters remain isolated. - Client action: Authenticate with an API key on a plan carrying the required entitlement and handle HTTP 403 (PLAN_ENTITLEMENT_REQUIRED) and HTTP 429 (PERIOD_QUOTA_EXCEEDED / EXPENSIVE_BUDGET_EXCEEDED) with Retry-After.
- Before: Version 1 gateway admission enforced Free/Pro/Enterprise RPM and monthly quota without server-side plan entitlement gates, Scale tier support, or paid billing-period allowances. Keys holding the
Verification: dashboard/tests/paid-plans-quota.test.ts; dashboard/tests/billing-stripe.test.ts; dashboard/tests/monthly-quota.test.ts; dashboard/tests/edge-cache.test.ts; dashboard/tests/admin-management.test.ts; dashboard/tests/legacy-analytics.test.ts; tests/middleware-origin-auth.test.ts; src/openapi/project-quota.ts; src/openapi/v1.ts; pnpm dashboard:test; pnpm test:unit; pnpm openapi:check; pnpm docs:check; pnpm release:check --base main.
2026-11-12 — Report email verification before terms acceptance in dashboard and console onboarding
Record: developer-onboarding-error-order.
- v1 GET /v1/open-api.json (getV1OpenApi; fixed; compatible)
- Before: During an active rollout, signed-in dashboard console requests with unverified email and no terms acceptance returned 403 AGREEMENT_REQUIRED. Dashboard gates also advertised terms before verification.
- After: Dashboard console requests return 403 EMAIL_VERIFICATION_REQUIRED until email is verified, then 403 AGREEMENT_REQUIRED until the current terms edition is accepted. Dashboard gates list required terms only after verification. Public API-key access, anonymous access, eligibility, quotas and successful responses are unchanged.
- Client action: Console clients should handle EMAIL_VERIFICATION_REQUIRED by verifying the notification email first, then handle AGREEMENT_REQUIRED by accepting the current terms. Existing application API-key integrations require no change.
Verification: dashboard/tests/developer-account.test.ts; dashboard/tests/console-sessions.test.ts; openapi/egdata.dashboard.openapi.json; src/openapi/v1.ts; apps/docs/content/docs/api-console.mdx; pnpm docs:check; pnpm release:check --base origin/main.
2026-11-12 — Remove Aikido origin runtime blocking and telemetry
Record: remove-aikido-runtime.
- v1 GET /v1/open-api.json (getV1OpenApi; security; compatible)
- Before: Requests reaching the Node origin passed globally installed Aikido runtime instrumentation and middleware, which could send request/security telemetry and impose Aikido-specific blocking or rate-limit grouping before the route handler.
- After: The updated origin no longer loads the Aikido SDK, sends its runtime telemetry, creates its IP/UA-derived user identity, or applies its blocking/grouping. Existing authentication, origin access controls, gateway quotas, legacy rate limits and custom legacy anti-abuse remain. Gateway-local responses that never reach the origin retain their prior behavior. v1 remains outside custom legacy challenges. Historical provider data is not erased by this code change; origin deployment is required.
- Client action: None. Continue honoring existing authentication, quotas and Retry-After responses. This record does not confirm production deployment.
Verification: src/index.ts; src/middlewares/rate-limit.ts; package.json; scripts/dev.mjs; tests/middleware-rate-limit.test.ts; tests/anti-abuse.test.ts; tests/v1-router.test.ts; src/openapi/index.ts; src/openapi/v1.ts; apps/docs/content/docs/regions-pagination-errors.mdx; pnpm test; pnpm build; pnpm docs:check.
2026-11-12 — Expose API gateway hostname and harden Worker edge caching
Record: worker-edge-cache.
- v1 GET /v1/open-api.json (getV1OpenApi; fixed; compatible)
- Before: The API gateway Worker was not bound to
api.egdata.app; additionally, eligible GET/HEAD requests used an edge-cache key that sorted repeated query values, allowing opposite value orders to share a cached representation. - After: The Worker is now bound to
api.egdata.appfor v1 requests. Eligible GET/HEAD cache keys sort query parameter names while preserving the original order of values with the same name, preserving origin query semantics. Protected requests still pass authentication, permissions, and quota admission before cache access; response contracts and outgoing private/no-store headers are unchanged. - Client action: None
- Before: The API gateway Worker was not bound to
Verification: dashboard/tests/edge-cache.test.ts; dashboard/tests/gateway.test.ts; dashboard/tests/v1-gateway.test.ts.
2026-11-11 — Apply administrator-approved project limits to API keys and console sessions
Record: admin-reviewed-project-limits.
- v1 GET /v1/open-api.json (getV1OpenApi; changed; compatible)
- Before: The v1 API description did not describe administrator review and inheritance of approved project quotas.
- After: The API description documents administrator-reviewed project limits, inheritance by keys and console sessions, and bounded cache propagation.
- Client action: None
Verification: dashboard/tests/limit-reviews.test.ts; dashboard/tests/console-sessions.test.ts; pnpm docs:check.
2026-11-11 — Keep API startup available while v1 indexes are provisioned separately
Record: keep-api-startup-independent-of-v1-indexes.
- v1 GET /v1/open-api.json (getV1OpenApi; fixed; compatible)
- Before: GET /v1/open-api.json was unavailable during API startup while v1 MongoDB index creation was pending; the proxy returned 502 before HTTP began listening.
- After: GET /v1/open-api.json becomes available after the existing database and catalog initialization, without waiting for v1 index provisioning. Its route, authentication, response format and limits are preserved.
- Client action: None
Verification: tests/server-startup.test.ts: stalled v1 index builds do not delay HTTP startup; database connectivity remains required; pnpm test; pnpm build; pnpm docs:check; pnpm release:check --base origin/main.
2026-11-11 — Try v1 operations with ten-minute project console sessions
Record: project-console-sessions.
- v1 GET /v1/open-api.json (getV1OpenApi; changed; compatible)
- Before: The v1 description documented only public API key authentication for data operations.
- After: The v1 description also documents optional ten-minute console sessions bound to the signed-in dashboard. Public application security schemes and operation schemas remain unchanged.
- Client action: None
Verification: dashboard/tests/console-sessions.test.ts; dashboard/tests/explorer.test.ts.
2026-11-11 — Preserve public v1 metadata responses through the Worker
Record: public-v1-metadata-response.
- v1 GET /v1/open-api.json (getV1OpenApi; fixed; compatible)
- Before: The Worker could throw while modifying immutable upstream response headers, returning HTTP 500 and preventing the explorer from loading the deployed contract.
- After: The Worker clones the response before applying its existing headers, preserving the deployed OpenAPI response status and streaming body. The API contract and routing are unchanged.
- Client action: None
Verification: dashboard/tests/v1-gateway.test.ts; pnpm dashboard:test; pnpm openapi:check.
2026-11-11 — Add the versioned v1 API with explicit scopes and per-key quotas
Record: versioned-v1-api.
- v1 GET /v1/open-api.json (getV1OpenApi; added; compatible)
- Before: GET /v1/open-api.json was not available in the versioned API.
- After: Version 1 OpenAPI document. Machine-readable OpenAPI 3.0 contract for the versioned public API. The legacy contract remains at /open-api.json. Response media: application/json. Public metadata operation; no API key required.
- Client action: None
Verification: tests/v1-router.test.ts; tests/v1-operations.test.ts; tests/v1-origin-provenance.test.ts; tests/middleware-origin-auth.test.ts; dashboard/tests/v1-gateway.test.ts; dashboard/tests/rate-limiter.test.ts; pnpm openapi:check.