API Documentation Deep Enrichment
SpeyDocs Deep Enrichment
Every route file in the API now carries property-level documentation — query parameters, request bodies, response codes, and field descriptions are all enriched directly in the route schemas. SpeyDocs renders these automatically, so the public API reference at docs.speybooks.com reflects the full detail without any manual page editing.
What Changed
467 descriptions added across 36 route files — covers every public and admin endpoint in the API. Parameter types, enum values, default behaviours, and error responses are all documented at the schema level.
Deep enrichment on 7 core route files — invoices, transactions, dividends, director loans, categorisation rules, bank imports, and migrations received full property-level treatment. Every query parameter, request body field, nested object, and response status code now has a description explaining what it does, what values it accepts, and what the constraints are.
Response-level enrichment on 3 admin route files — admin, admin additions, and admin bug reports now document every response status code across all 31 admin endpoints.
Batch enrichment on 26 remaining route files — endpoint-level summaries, operation IDs, and response descriptions across accounts, contacts, reports, quotes, auth, billing, and all import pipelines.
Documentation Site Fix
- Request code block wrapping — long curl commands in the SpeyDocs API reference now wrap properly instead of requiring horizontal scrolling. JSON response blocks are unaffected and keep their indented structure.