Codex cowork-server REST API Design for Filters and Pagination
Use existing resource paths, query binding rules, response wrappers, and OpenAPI annotations for a new cowork-server list endpoint.
中文Install in Codex
Codex with a cowork-server checkout, its Kotlin controllers and response classes, and an API example to compare.
- Open the pinned GitHub original and retain the complete `.agents/skills/api-design/` directory in the checkout.
- Open Codex in that checkout and invoke `$api-design` with the example task and desired output.
Example task
Invoke `$api-design` in a local practice project to draft a library listing with status filtering and pagination. Request a sample request and response fields.What to check
The design names the collection path, page controls, response structure, and OpenAPI summary. Consumers can write local tests from the contract.
Original SKILL.md on GitHub · Updated
Frequently asked question
How is an ordinary successful response wrapped?
The upstream guide uses CommonApiResponse with its data field. Errors follow the existing global handler.