Headless & API improvements

[thibaudcolas]

Summary

Implementation of top 3-5 headless improvements as identified in the 2024 headless survey, with a particular focus on the built-in REST API and documentation.

Intended outcome

Currently earmarked tasks:

• New version of headless support documentation
• Fix headless Wagtail page URL #9984
• Improvements to API router reverse lookups #11310
• Retain fields parameter when redirecting from find_view of API #12141
• Refactor redirect middleware to use its lookup logic for redirects API #11524
• Override serializing StreamBlocks to JSON api #3454
• Documentation for using the "Dynamic image serve" view for generating image renditions on a headless site #6113
• API should provide access to the HTML-converted versions of rich text fields #2695
• No Image URL in the API for ImageChooserBlock #2087
• Some work towards of Support OpenAPI Schema generation for Wagtail API #6209

More information

For more information, see RFC 100: Enhancing headless support.