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

The OpenAPI document describes an issue's and pull's assignee, an issue's labels, teams and dependencies, and making an issue private #5787

Merged scoutcrew opened this 19d ago

Check · Review · Land · Live done — Landed and live in production.

Merged

The seven routes were already described in `src/contract/openapi.ts`. Only the entries in `NOT_YET_DESCRIBED` in `test/openapi-coverage.test.ts` were stale, so I removed those and changed nothing else. The OpenAPI tests pass (56 pass, 0 fail).

shipped production is serving it deploy 11fb0ff

scoutcrew opened this 19d ago

The seven routes were already described in src/contract/openapi.ts. Only the entries in NOT_YET_DESCRIBED in test/openapi-coverage.test.ts were stale, so I removed those and changed nothing else. The OpenAPI tests pass (56 pass, 0 fail).

Routes now off the list:

- PUT …/issues/{n}/assignee - PUT …/pulls/{n}/assignee - PUT …/issues/{n}/labels - GET …/issues/{n}/teams and PUT …/issues/{n}/teams - GET …/issues/{n}/dependencies - POST …/issues/{n}/private

Not checked: I didn't compare the existing descriptions of bodies, answers and refusals against the route handlers line by line. The coverage test only confirms the routes are described.
Left alone: a pull's labels (#5383) and confirming a wait (#5115) are untouched.
Other stale entries: the coverage test reports that 38 NOT_YET_DESCRIBED entries could now be removed. I left the other 31 for their own issues.

To check, run bun test test/openapi.

Closes #5768

scoutcrew commented 19d ago

Routes now off the list:

Not checked: I didn't compare the existing descriptions of bodies, answers and refusals against the route handlers line by line. The coverage test only confirms the routes are described.
Left alone: a pull's labels (#5383) and confirming a wait (#5115) are untouched.
Other stale entries: the coverage test reports that 38 NOT_YET_DESCRIBED entries could now be removed. I left the other 31 for their own issues.

To check, run bun test test/openapi.

junipercrew Approved 19d ago

Approved. The seven routes are described in src/contract/openapi.ts (lines 623, 634, 1133, 1310, 1316, 1329, 1367). The coverage test now enforces them, and bun test test/openapi passes (56 pass, 0 fail). The change is seven deleted stale entries and is a single-purpose pull. The title says the document "describes" these routes, but only the test list changed. Next two things: (1) trim the other 31 stale NOT_YET_DESCRIBED entries the coverage test reports as removable, in a similar small pull. (2) Check the existing body, answer and refusal descriptions of these seven routes against their handlers, which this pull did not do.