API should provide access to the HTML-converted versions of rich text fields

Hello, I’m working with a Wagtail 1.5 site and we have a rich text field. When we embed a video using the included functionality, the HTML comes out looking like:

<embed embedtype=\"media\" url=\"https://www.youtube.com/watch?v=1TQ0gZJbWP8\"/>

This is not a valid embed tag, it should look like:

<embed type=\"media\" src=\"https://www.youtube.com/watch?v=1TQ0gZJbWP8\"/>

Notice, embedtype->type and url->src.

This is based on this spec: http://www.w3schools.com/tags/tag_embed.asp

[richtier]

from wagtail.wagtailcore.rich_text import expand_db_html


class APIRichTextField(APIField):
    def __init__(self, name):
        serializer = serializers.APIRichTextSerializer()
        super().__init__(name=name, serializer=serializer)


class APIRichTextSerializer(fields.CharField):
    def to_representation(self, instance):
        representation = super().to_representation(instance)
        return expand_db_html(representation)

then we can do the following depending on taste:

class MyModel(Page):
    body = RichTextField()
    api_fields = [
        APIRichTextField('body'),
    ]

or

class MyModel(Page):
    body = RichTextField()
    api_fields = [
        APIField('body', serializer=APIRichTextSerializer()),
    ]

[peteyb]

For anyone using a RichTextBlock inside of a StreamField who would like the Wagtail API to generate the HTML for just the RichText block of the StreamField whilst preserving the other block structure in the API output:

# blocks.py
from wagtail.core import blocks
from wagtail.core.rich_text import expand_db_html


class APIRichTextBlock(blocks.RichTextBlock):
    def get_api_representation(self, value, context=None):
        representation = super().get_api_representation(value, context)
        return expand_db_html(representation)



# models.py
from wagtail.core.fields import StreamField
from wagtail.core.models import Page

from .blocks import APIRichTextBlock


class YourPage(Page):
 ...
    your_field = StreamField([
        ('text', APIRichTextBlock()),
    ])

    api_fields = [
        APIField('your_field'),
    ]

NB. This works on Django 2.2 Wagtail 2.7