Repository navigation
Releases
Releases · tomdyson/wagtail-write-api
v0.8.5
What's new
- QR code reveal button: The admin mobile page now hides the QR code behind a "Show QR Code" button to prevent accidental exposure during screen-sharing
- Fix rich text rendering: Example app templates now load the Tailwind Typography plugin so
proseclasses render rich text HTML correctly
Upgrade notes
No API contract changes. Drop-in replacement for 0.8.4.
v0.8.4
What's new
- QR code login for Wagtail Mobile: New "Mobile app" page in the Wagtail admin sidebar displays a QR code encoding the API URL and user token. Scan with the Wagtail Mobile app to connect instantly — no typing credentials on your phone.
Details
- New admin view registered via
wagtail_hooks.pyat/admin/mobile/ - QR code generated as inline SVG (using
qrcodelibrary, no Pillow required) - API base URL auto-detected via URL reversing
- New dependency:
qrcode>=7.0
v0.8.3
v0.8.2
v0.8.1
New
- RichTextBlock values inside StreamField blocks now accept the
{format: "markdown", content: "..."}wrapper, matching the existing behaviour for top-level RichTextField. Conversion applies recursively through StructBlocks.
This makes round-trip editing simpler for clients that read with ?rich_text_format=markdown — they can send markdown back without client-side HTML conversion.
v0.8.0
What's new
Token authentication endpoint
POST /auth/token/— exchange username/password for an API token, enabling mobile and browser-based login flows without manual token management
Per-request markdown output for rich text
- Add
?rich_text_format=markdownquery parameter to page detail endpoint - Rich text fields (RichTextField and RichTextBlock in StreamField) are converted to Markdown server-side using markdownify
- The existing
RICH_TEXT_OUTPUT_FORMATglobal setting now actually works (was previously defined but not wired up) - Query parameter overrides the global setting per-request
Round-trip fidelity
- Bold, italic, headings, links, lists, and images survive markdown read/write round-trips
- 34 new tests covering auth endpoint and rich text conversion fidelity
⚠️ Wagtail internal page links are expanded to URL paths in markdown output — use wagtail:// syntax in markdown input to preserve page ID references
v0.7.1
v0.7.0
v0.6.0
Snippet CRUD support
Add full read/write API support for Wagtail snippets (models registered with @register_snippet).
- Snippet endpoints:
GET/POST /snippets/,GET/PATCH/DELETE /snippets/{id}/— all requiretypequery parameter - Schema discovery:
GET /schema/snippets/andGET /schema/snippets/{type}/for snippet type introspection - Schema generator: refactored to support both page and snippet models (
model_kindparameter) - Settings: new
EXCLUDE_SNIPPET_TYPESoption - Example
CategoryandTagsnippet models with seed data
This release aligns version numbering with wagapi — both projects now share minor versions to indicate API compatibility.
v0.4.2
Bug fixes
- Create+publish atomicity: when a user has
addbut notpublishpermission,action: "publish"no longer leaves an orphan draft page behind. The entire operation is now wrapped in a database transaction.
Documentation
- Added "Not yet supported" section to README listing snippets, documents, multi-site, locales, and other features not yet covered by the API.