Examples for NestedHyperlinkedRelatedField (from drf-nested-routers)

[TauPan]

This is sort of a proposal / feature request.

I wanted to see proper examples for those urls instead of https://example.com so I came up with this:

class NestedHyperlinkedRelatedFieldExtension(OpenApiSerializerFieldExtension):
    target_class = 'rest_framework_nested.relations.NestedHyperlinkedRelatedField'
    priority = 1

    def map_serializer_field(
            self,
            auto_schema: 'AutoSchema',
            direction: Direction) -> _SchemaType:
        ret = auto_schema._map_serializer_field(
            self.target, direction, bypass_extensions=True)
        ret['examples'] = [
            'https://example.com' +
            self.target.reverse(
                self.target.view_name,
                [1] * (len(self.target.parent_lookup_kwargs) + 1))]
        return ret

Is there a way to have the url schema and hostname not be static? (I don't mind really, so this is good enough for me.)

Would this maybe be considered for inclusion in a future version of drf-spectacular?

Best regards
Friedel

[tfranzel]

Hi Friedel,

interesting thought. As far as I can recall, all of those example.com examples do originate from DRF. Those are mainly hardcoded in the upstream pagination classes. I do agree that this could have been better, but monkeypatching those TLD buried in DRF seems quite brittle. Subclassing those pagination classes and extending get_paginated_response_schema seems the cleanest approach for now.

In case of spectaculars own examples, nothing is preventing you from str substitute a constant with your domain in there.

I would lean towards the current state, as this may add complexity with limited benefit.

[TauPan]

Thanks for the pointers!

I would lean towards the current state, as this may add complexity with limited benefit.

I can definitely live with that. :-)