SpeyDocs: Static Pages, Schema Resolution & Code Panel Polish
Static Documentation Pages
SpeyDocs now serves 15 hand-written documentation pages alongside the 251 API reference pages. The sidebar is reorganised into clear sections: Introduction, Getting Started, Concepts, Guides, API Reference, and the existing resource categories.
- Getting Started — Quick Start, Authentication Setup, Developer Shell, and Your First Invoice walk new developers through onboarding step by step.
- Concepts — How It Works, Double-Entry Bookkeeping, Chart of Accounts, VAT Handling, and Multi-Currency explain the accounting model behind the API.
- Guides — VAT Returns, Bank Reconciliation, CSV Import, Dividends, and Webhooks cover practical workflows end to end.
Docusaurus-style admonitions (note, tip, caution, warning, danger) are converted at build time and render with colour-coded callout styling.
Schema Resolution for Request Bodies
Sixteen endpoints across Accounts, Contacts, Transactions, Directors, Dividends, Organisation, Webhooks, and Director Loans previously showed empty request body sections. The build now resolves writable fields from component schemas at load time, filtering out read-only fields like id, createdAt, and isSystem. Every POST and PUT endpoint now shows the full list of submittable fields with types, required badges, and descriptions.
Parameter Defaults & Validation Constraints
- Defaults — Query parameters and request body fields now display their default values inline (e.g.
activedefaults totrueon list endpoints). - Constraints — Validation rules surface directly on fields:
min length: 8on passwords,format: dateon date fields,min items: 1on invoice lines,patternon date strings.
Nested Parameter Expansion
Array-of-object and nested object fields now include a collapsible “Show child parameters” toggle. Invoice lines, quote lines, and categorisation rule batch fields expand to reveal their child schemas with types, required badges, and descriptions.
Code Panel Enhancements
- Method + path header — Request blocks now display the HTTP method and endpoint path (e.g.
POST /v1/invoices/) with method-coloured badges. - COPY button — Every code block includes a copy-to-clipboard button with visual feedback.
Branding Update
The docs site logo is now the SpeyBooks API wordmark with the river wave element, matching the main brand identity. Theme-aware fills ensure it renders correctly in both light and dark modes.
Bug Fixes
- Fixed code blocks on static pages rendering with a white overlay caused by inline-code background styles leaking into fenced code blocks.
- Static pages now use the standard two-panel grid layout (content + empty code panel) instead of collapsing to full width, maintaining visual consistency with the API reference.