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

The OpenAPI document describes boards: list, read, write, delete, panels, pins, sources and query #4852

shipped production is serving it opened this has it
opened this

Intent: a harness can build and read the owner's boards through OpenAPI alone.

Done:

  • [ ] rows for GET /api/v1/boards, GET/PUT/DELETE /api/v1/boards/{slug}, GET /api/v1/boards/{slug}/panels/{id}, GET/POST /api/v1/boards/pins, GET /api/v1/boards/sources and POST /api/v1/boards/query, placed right after the existing GET /api/v1/migrate/{job} row
  • [ ] the query row names the body fields the handler reads and its refusals, including the one for an unknown source

Each row says what the route answers (its shape in the summary), whether it needs a token (auth), and its body fields, query and refusals, as the existing rows do. If #4844 has not yet added "put" to the Route method type and a route here needs it, add it here. test/openapi.test.ts must still pass, and a new test asserts each new path and method is in the served document. Other issues add OpenAPI rows in parallel, so put these exactly where named.

Sign in to join this conversation.

↑↓ navigate ↵ open ⌘↵ its app esc close

Keyboard shortcuts

Docs