chore(tool_router): mark /execute_meta as deprecated

@zen-agentchecks n/achecks…zen/deprecate-execute-meta-xjtfar → master6 files · +14 −5review: @sohamganatrareview: @kaavee315review: @lingalarahul7review: @anshugarg15updated 1mo ago

GitHub

▸Description· 2 comments · 6 noise

Description

Marks the tool-router /execute_meta endpoints (v3 + v3.1) as deprecated in the OpenAPI spec. The endpoint remains fully functional and continues to appear in every docs / SDK preset — only the OpenAPI deprecated: true flag changes, plus an updated summary/description that redirects callers to /execute.

Why a soft deprecation (visible + flagged) rather than hiding from docs: existing SDKs already shipped with a session.execute_meta(...) method generated from this spec. Removing the endpoint from public_docs / sdk_docs presets would make the next SDK regeneration drop the method, breaking source-level compatibility for anyone still calling it. With deprecated: true alone, the next SDK regen keeps the method (typically annotated as deprecated) and existing callers stay on a supported path while we steer new code at /execute.

What changed for each endpoint:

deprecated: true at the operation level.
Summary prefixed [Deprecated] …; description rewritten to redirect callers to /api/v3(.1)/tool_router/session/{session_id}/execute, which already handles both meta tools (COMPOSIO_*) and app tools.
Visibility unchanged ([API_DOCS, SDK, FRONTEND]) — endpoint still appears in public_docs, sdk_docs, frontend_docs, and mcp_docs presets, just marked deprecated.

Plumbing changes to make the deprecation actually land in the emitted spec:

createRPCToolRoute now accepts an optional deprecated flag and passes it through createAuthRoute → createRoute.
RouteWithMetadata (lib/openapi/filtering.ts) gains an optional deprecated field.
generateOpenApiDocFromRoutes (lib/openapi/helpers.ts) now propagates the flag onto the route config it hands to OpenAPIHono.openapi(). Previously this layer rebuilt route configs from a manual whitelist of fields and silently dropped deprecated, so even with the flag set correctly upstream the spec never showed it.

Apollo lib/CLAUDE.md updated to document the deprecation state.

How did I test this PR

doppler run -- pnpm lint — clean (only one pre-existing warning in composio_actions/utils/schemas.ts, unrelated)
doppler run -- pnpm format:check — clean
doppler run -- pnpm check-types — clean
Scoped vitest:
- vitest run src/pages/api/v3/tool_router/session/[session_id]/execute_meta.test.ts src/proxy.test.ts → 7/7 pass
- Also ran execute_meta_workbench.test.ts earlier in the iteration → 22/22 pass
Local Apollo spec verification (port 9900) across all four public presets:
- GET /api/v3/openapi.json?preset=public_docs → /execute_meta present, deprecated: true, summary [Deprecated] …
- GET /api/v3/openapi.json?preset=sdk_docs → same
- GET /api/v3/openapi.json?preset=frontend_docs → same
- GET /api/v3/openapi.json?preset=mcp_docs → same
- All four checks identical for v3.1 paths
- Sibling routes (/execute, /search) confirmed deprecated is still absent (no collateral)
Runtime sanity: curl -X POST .../execute_meta -d '{"slug": "COMPOSIO_MANAGE_CONNECTIONS", ...}' returns the expected 404 SessionNotFound — handler still reachable.

@zen-agent1mo ago

Post-PR Status

Codex review: LGTM — no actionable issues. Quote: "The changes correctly propagate route-level deprecation metadata into generated OpenAPI docs and intentionally narrow execute_meta visibility while preserving the runtime route. I did not identify any discrete regressions introduced by this patch."

CI: 27 of 28 checks green on commit f83aaa88.

Vitest Tests, Vitest E2E Tests, Vitest Self-Hosted Tests, Auth Config Vitest Tests, Trigger Config Vitest Tests, Lint Apollo, Lint Staged Files, all Thermos checks, both Apollo Integration Tests (Core Platform + Tool Router), Retool Unit Tests, CodeQL Analyze (go/actions/python/javascript-typescript), Secrets Detection, Check PR Description — all ✅
Vitest Tests failed once with a 20s timeout on execute_meta.test.ts > should reach execution stage for COMPOSIO_MANAGE_CONNECTIONS. Same test passed locally (5s) and passed on CI rerun — flake.
Self-hosting Env Var Check ❌ — pre-existing infrastructure issue. The OpenAI key the workflow uses returns 401 invalid_api_key. This workflow fails on every recent PR (zen/tool-log-parent-*, zen/toolrouter-auto-preload-*, zen/shared-conn-gate-*, etc.) but succeeds on master pushes. Not caused by this change.

Verification artifacts (local Apollo):

GET /api/v3/openapi.json?preset=public_docs → /execute_meta not present (HIDDEN)
GET /api/v3/openapi.json?preset=sdk_docs → /execute_meta not present (HIDDEN)
GET /api/v3/openapi.json?preset=frontend_docs → /execute_meta present, deprecated: true, summary prefixed [Deprecated] …
Same three checks for v3.1 — identical results
Sibling routes (/execute, /search) — deprecated still absent → no collateral

▸ 6 bot/status comments hidden

@vercel[bot]1mo ago

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
apollo	Ready	Preview, Comment	May 12, 2026 1:29pm

Project	Deployment	Actions	Updated (UTC)
debby	Skipped		May 12, 2026 1:29pm

@github-actions[bot]1mo ago

🔍 Suggested Reviewers

Based on git blame analysis of 6 file(s):

Contributor	Contribution	Files
Zen	37%	6
abir-taheer	32%

loading diff…

Description

What changed for each endpoint:

deprecated: true at the operation level.

Summary prefixed [Deprecated] …; description rewritten to redirect callers to /api/v3(.1)/tool_router/session/{session_id}/execute, which already handles both meta tools (COMPOSIO_*) and app tools.

Visibility unchanged ([API_DOCS, SDK, FRONTEND]) — endpoint still appears in public_docs, sdk_docs, frontend_docs, and mcp_docs presets, just marked deprecated.

Plumbing changes to make the deprecation actually land in the emitted spec:

createRPCToolRoute now accepts an optional deprecated flag and passes it through createAuthRoute → createRoute.

RouteWithMetadata (lib/openapi/filtering.ts) gains an optional deprecated field.

generateOpenApiDocFromRoutes (lib/openapi/helpers.ts) now propagates the flag onto the route config it hands to OpenAPIHono.openapi(). Previously this layer rebuilt route configs from a manual whitelist of fields and silently dropped deprecated, so even with the flag set correctly upstream the spec never showed it.

Apollo lib/CLAUDE.md updated to document the deprecation state.

How did I test this PR

doppler run -- pnpm lint — clean (only one pre-existing warning in composio_actions/utils/schemas.ts, unrelated)

doppler run -- pnpm format:check — clean

doppler run -- pnpm check-types — clean

Scoped vitest:

vitest run src/pages/api/v3/tool_router/session/[session_id]/execute_meta.test.ts src/proxy.test.ts → 7/7 pass
Also ran execute_meta_workbench.test.ts earlier in the iteration → 22/22 pass

Local Apollo spec verification (port 9900) across all four public presets:

GET /api/v3/openapi.json?preset=public_docs → /execute_meta present, deprecated: true, summary [Deprecated] …
GET /api/v3/openapi.json?preset=sdk_docs → same
GET /api/v3/openapi.json?preset=frontend_docs → same
GET /api/v3/openapi.json?preset=mcp_docs → same
All four checks identical for v3.1 paths
Sibling routes (/execute, /search) confirmed deprecated is still absent (no collateral)

Runtime sanity: curl -X POST .../execute_meta -d '{"slug": "COMPOSIO_MANAGE_CONNECTIONS", ...}' returns the expected 404 SessionNotFound — handler still reachable.

Post-PR Status

CI: 27 of 28 checks green on commit f83aaa88.

Vitest Tests, Vitest E2E Tests, Vitest Self-Hosted Tests, Auth Config Vitest Tests, Trigger Config Vitest Tests, Lint Apollo, Lint Staged Files, all Thermos checks, both Apollo Integration Tests (Core Platform + Tool Router), Retool Unit Tests, CodeQL Analyze (go/actions/python/javascript-typescript), Secrets Detection, Check PR Description — all ✅

Vitest Tests failed once with a 20s timeout on execute_meta.test.ts > should reach execution stage for COMPOSIO_MANAGE_CONNECTIONS. Same test passed locally (5s) and passed on CI rerun — flake.

Self-hosting Env Var Check ❌ — pre-existing infrastructure issue. The OpenAI key the workflow uses returns 401 invalid_api_key. This workflow fails on every recent PR (zen/tool-log-parent-*, zen/toolrouter-auto-preload-*, zen/shared-conn-gate-*, etc.) but succeeds on master pushes. Not caused by this change.

Verification artifacts (local Apollo):

GET /api/v3/openapi.json?preset=public_docs → /execute_meta not present (HIDDEN)

GET /api/v3/openapi.json?preset=sdk_docs → /execute_meta not present (HIDDEN)

GET /api/v3/openapi.json?preset=frontend_docs → /execute_meta present, deprecated: true, summary prefixed [Deprecated] …

Same three checks for v3.1 — identical results

Sibling routes (/execute, /search) — deprecated still absent → no collateral

Project

Deployment

Actions

Updated (UTC)

apollo

Ready

Preview, Comment

May 12, 2026 1:29pm

Project

Deployment

Actions

Updated (UTC)

debby

Skipped

May 12, 2026 1:29pm

Contributor

Contribution

Files

Zen

37%

abir-taheer

32%

Files with missing lines	Patch %	Lines
apps/apollo/src/lib/openapi/helpers.ts	0.00%	3 Missing :warning:
...1/tool_router/session/[session_id]/execute_meta.ts	0.00%	3 Missing :warning:

Flag	Coverage Δ
e2e-tests	`5.82% <0.00%> (+0.06%)`	:arrow_up:
self-hosted-tests	`5.64% <0.00%> (+0.06%)`	:arrow_up:
thermos-service-isolation-tests	`?`
thermos-unit-tests	`?`
unit-tests	`58.77% <45.45%> (+0.50%)`	:arrow_up:

Files with missing lines	Coverage Δ
apps/apollo/src/lib/openapi/filtering.ts	`65.07% <ø> (ø)`
...3/tool_router/session/[session_id]/execute_meta.ts	`85.10% <100.00%> (+0.32%)`	:arrow_up:
.../apollo/src/server/rpc_tools/create_api_wrapper.ts	`87.50% <100.00%> (+0.21%)`	:arrow_up:
apps/apollo/src/lib/openapi/helpers.ts	`18.51% <0.00%> (-0.30%)`	:arrow_down:
...1/tool_router/session/[session_id]/execute_meta.ts	`0.00% <0.00%> (ø)`

chore(tool_router): mark /execute_meta as deprecated

Description

How did I test this PR

Post-PR Status

🔍 Suggested Reviewers

Description

How did I test this PR

Post-PR Status

🔍 Suggested Reviewers

Post-PR Follow-up (commit `fc48950`)

💡 Recommendation

🧪 Test Results Summary (Self-Hosted Tests)

🧪 Test Results Summary (Unit Tests)

Codecov Report

🧪 Test Results Summary (E2E Tests)

Description

How did I test this PR

Post-PR Status

🔍 Suggested Reviewers

Description

How did I test this PR

Post-PR Status

🔍 Suggested Reviewers

Post-PR Follow-up (commit fc48950)

💡 Recommendation

🧪 Test Results Summary (Self-Hosted Tests)

🧪 Test Results Summary (Unit Tests)

Codecov Report

🧪 Test Results Summary (E2E Tests)

Post-PR Follow-up (commit `fc48950`)