Skip to content

chore: remove stale openapi.yaml#993

Merged
willwashburn merged 1 commit into
mainfrom
claude/zen-tesla-0oAEk
May 26, 2026
Merged

chore: remove stale openapi.yaml#993
willwashburn merged 1 commit into
mainfrom
claude/zen-tesla-0oAEk

Conversation

@willwashburn
Copy link
Copy Markdown
Member

Summary

The root openapi.yaml documented an older "Agent Relay Daemon API" that no longer matches the broker's actual HTTP surface in crates/broker/src/listen_api.rs. It was orphaned — not referenced by docs, build tooling, or generated clients.

Drift examples

  • /agents, /agents/{name}/kill, /release → consolidated under /api/spawned (DELETE /api/spawned/{name})
  • /spawn/api/spawn (auth required)
  • /messages (GET/POST) → /api/send (history endpoint dropped)
  • /who, /consensus/status → removed
  • Many real endpoints missing from the YAML: /api/session{,/renew}, /api/config, /api/spawned/{name}/{model,subscribe,unsubscribe,snapshot,delivery-mode,pending,flush}, /api/agents/by-name/{name}/interrupt, /api/crash-insights, /api/threads, /api/agent-result, /ws

The authoritative API reference lives at web/content/docs/reference-broker-api.mdx.

Test plan

  • CI passes (no references to openapi.yaml exist in the repo)

Generated by Claude Code

The root openapi.yaml documented an old daemon API that no longer matches
the broker's HTTP surface in crates/broker/src/listen_api.rs. It was not
referenced by docs, build, or generated clients. The authoritative API
reference lives at web/content/docs/reference-broker-api.mdx.
@willwashburn willwashburn requested a review from khaliqgant as a code owner May 26, 2026 11:08
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request completely removes the OpenAPI specification file for the Agent Relay Daemon API. Since there are no review comments provided, there is no additional feedback to address.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 26, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 53874f88-aaad-49af-b83c-6be6a165cdb4

📥 Commits

Reviewing files that changed from the base of the PR and between 48bc831 and 10b99df.

📒 Files selected for processing (1)
  • openapi.yaml
💤 Files with no reviewable changes (1)
  • openapi.yaml

📝 Walkthrough

Walkthrough

The entire OpenAPI specification document (openapi.yaml) has been removed from the repository, eliminating the previously maintained REST API contract including all endpoint definitions, component schemas, and authentication configuration.

Changes

Cohort / File(s) Summary
OpenAPI contract removal
openapi.yaml
Complete removal of the OpenAPI specification file (486 lines). This includes all documented API endpoints (/health, /status, /agents, /spawn, /messages, /who, /metrics, /consensus/status), component schemas, and the apiKey security scheme definition.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested reviewers

  • khaliqgant

Poem

🐰 The spec once lived in YAML bright,
With paths and schemas, clean and tight,
But now it vanishes from sight—
A rabbit whispers, "Off you go!"
Let the contract live, let the old doc flow. ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: removing the stale openapi.yaml file, which is the primary action in this changeset.
Description check ✅ Passed The description covers required sections with clear context: explains what was removed and why (API drift), provides concrete examples, references the authoritative API docs, and includes a test plan.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/zen-tesla-0oAEk

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 1 file

Re-trigger cubic

@willwashburn willwashburn merged commit 0fdcd14 into main May 26, 2026
2 checks passed
@willwashburn willwashburn deleted the claude/zen-tesla-0oAEk branch May 26, 2026 11:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants