Skip to content
This repository was archived by the owner on Sep 7, 2026. It is now read-only.

chore: remove stale swagger spec - #292

Merged
neubig merged 1 commit into
mainfrom
agent/remove-stale-swagger-doc
Jul 30, 2026
Merged

neubig merged 1 commit into
mainfrom
agent/remove-stale-swagger-doc

Conversation

@neubig

@neubig neubig commented Jul 27, 2026 •

Copy link
Copy Markdown
Member

Summary

  • Remove the unreferenced root-level swagger-doc.json.
  • Drop the stale /api/conversations/{conversation_id}/generate_title contract and its GenerateTitleRequest / GenerateTitleResponse schemas.

Why

An org-wide usage check for OpenHands/software-agent-sdk#4225 found these otherwise-dead models only in this Swagger snapshot. The file was added with the initial TypeScript client implementation, is not referenced by the package source or build, and no longer reflects the current agent-server routes.

Impact

No runtime or published-package behavior changes. This removes a misleading, unused API artifact.

Validation

  • Confirmed no repository references to swagger-doc.json.
  • npm run lint (0 errors; 17 pre-existing warnings)
  • npm run build
  • env -u AGENT_SERVER_URL npm run test:coverage (290 passed)
  • npm run format:check

Closes OpenHands/software-agent-sdk#4757

@github-actions github-actions Bot added the type: chore Maintenance / chores label Jul 27, 2026
@neubig
neubig requested a review from VascoSch92 July 27, 2026 09:00
@github-actions

Copy link
Copy Markdown
Contributor

Endpoint audit

❌ 40 off-contract call(s) — not on the agent-server · classifiers: cloud

Category Count
❌ Off-contract (not on agent-server) 40
  ⛔ no known backend 15
  ↗️ served by cloud 25
➕ Missing API (agent-server has, client lacks) 11
agent-server endpoints 121
client endpoints 148

❌ Not on agent-server (gated, 40)

⛔ (no known backend) — served by no backend we can see (15)

  • DELETE /api/automation/v1/{}
  • DELETE /api/meta-profiles/{}
  • GET /api/automation/health
  • GET /api/automation/v1
  • GET /api/automation/v1/{}
  • GET /api/automation/v1/{}/runs
  • GET /api/automation/v1/{}/tarball
  • GET /api/meta-profiles
  • GET /api/meta-profiles/{}
  • GET /api/v1/config/models/search{}
  • GET /api/v1/config/providers/search{}
  • PATCH /api/automation/v1/{}
  • POST /api/automation/v1/{}/dispatch
  • POST /api/meta-profiles/{}
  • POST /api/meta-profiles/{}/activate

↗️ served by cloud (25)

  • DELETE /api/v1/app-conversations/{}
  • DELETE /api/v1/secrets/{}
  • GET /api/keys/current
  • GET /api/organizations
  • GET /api/shared-events/search
  • GET /api/v1/app-conversations/search
  • GET /api/v1/app-conversations/{}/download
  • GET /api/v1/app-conversations/{}/file
  • GET /api/v1/git/branches/search
  • GET /api/v1/git/installations/search
  • GET /api/v1/git/repositories/search
  • GET /api/v1/secrets/search
  • GET /api/v1/settings
  • GET /api/v1/settings/agent-schema
  • GET /api/v1/settings/conversation-schema
  • GET /api/v1/skills/search
  • PATCH /api/v1/app-conversations/{}
  • POST /api/v1/app-conversations
  • POST /api/v1/app-conversations/{}/switch_acp_model
  • POST /api/v1/app-conversations/{}/switch_profile
  • POST /api/v1/sandboxes/{}/pause
  • POST /api/v1/sandboxes/{}/resume
  • POST /api/v1/secrets
  • POST /api/v1/settings
  • PUT /api/v1/secrets/{}

➕ Missing API — agent-server exposes it, client does not implement (11)

  • GET /
  • GET /api/conversations
  • GET /api/conversations/{}/events
  • GET /api/conversations/{}/workspace
  • GET /api/conversations/{}/workspace/{}
  • GET /api/file/archive
  • GET /api/git/commits
  • GET /api/git/commits/{}/changes
  • GET /api/init
  • POST /api/conversations/{}/load_plugin
  • POST /api/init

@neubig
neubig marked this pull request as ready for review July 27, 2026 09:23
@neubig
neubig merged commit 45693bf into main Jul 30, 2026
13 checks passed
@neubig
neubig deleted the agent/remove-stale-swagger-doc branch July 30, 2026 20:33
@openhands-release-bot openhands-release-bot Bot added the released: v1.37.0 Shipped in v1.37.0 label Aug 4, 2026
@openhands-release-bot

Copy link
Copy Markdown
Contributor

🚀 Released in v1.37.0.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

released: v1.37.0 Shipped in v1.37.0 type: chore Maintenance / chores

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Remove stale Swagger specification

2 participants