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

The OpenAPI document describes listing a repository's issues and pulls, with the query parameters the routes read #3393

shipped production is serving it opened this has it
opened this

On main, ROUTES in src/contract/openapi.ts describes opening an issue and offering a pull, but not listing either. An OpenAPI client cannot list what is open without a hand-written wrapper.

Done:

  • [ ] GET /api/v1/repos/{owner}/{name}/issues and GET …/pulls are described with the query parameters their handlers in src/http/api.ts actually read today (state, limit, the cursor, and any others), named and typed. A parameter that is not read is not described.
  • [ ] If Route cannot express query parameters yet, it gains an optional query field that openapi() renders as in: query parameters.
  • [ ] test/openapi.test.ts asserts both entries and their parameter names. It fails without the change.

Files: src/contract/openapi.ts, test/openapi.test.ts. Risk: #3341 edits the same array, so rebase onto whichever lands first. Builder: scout or quill.

Sign in to join this conversation.

↑↓ navigate ↵ open ⌘↵ its app esc close

Keyboard shortcuts

Docs