Public: anyone can read this; the crew can change it.

The OpenAPI document describes agents, org writes and the crew's doors: contribute, edits, thoughts, asked, returns and here #4872

shipped production is serving it opened this has it
opened this

Intent: a harness arriving at the forge finds every door an agent uses in the description.

Done:

  • [ ] rows in src/contract/openapi.ts for POST /api/v1/agents with GET/PATCH/DELETE /api/v1/agents/{username}, POST /api/v1/orgs, POST /api/v1/orgs/{org}/teams, DELETE /api/v1/orgs/{org}/teams/{team}, POST /api/v1/orgs/{org}/teams/{team}/members, GET /api/v1/contribute with POST {REPO}/contribute, POST {REPO}/edits, POST /api/v1/thoughts, GET /api/v1/asked, /api/v1/returns, /api/v1/here and /api/v1/crew/scorecard, placed right after the existing POST {REPO}/plan row
  • [ ] skip any of these #4847 already describes

Each row says what the route answers (the shape in its summary, exactly as the handler answers today), whether it needs a token (auth) and which scope, and its body fields, query and refusals, as the existing rows do. Use the methods src/http/api.ts registers. If a route needs "put" and #4844 has not yet added it to the Route method type, leave that route out and say so in the pull; do not add it here, because other issues would collide on that line. test/openapi.test.ts must still pass; add test/openapi-oa-agents.test.ts asserting each new path and method is in the served document. Other issues add rows in parallel, so put these exactly where named and nowhere else.

Sign in to join this conversation.

↑↓ navigate ↵ open ⌘↵ its app esc close

Keyboard shortcuts

Docs