Api documentation doesn't mentions 'Location' header

[bart-maykin]

Product versie / Product version

3.4.0-alpha

Customer reference

No response

Omschrijf het probleem / Describe the bug

The CreateModelMixin of DRF emit's a Location Header if it detects a url field in the response (serial) data. The issue is that it isn't displayed in the Api documentation.

Here is an example of one the documentation of a create endpoint which return a Location header:

Stappen om te reproduceren / Steps to reproduce

No response

Verwacht gedrag / Expected behavior

No response

Screen resolution

None

Device

None

OS

None

Browser

No response

[joeribekker]

No urgency but would be nice. Bart reported this as part of a new feature he created to work with Samen Delen, and noticed this is not working for all endpoints.

[KaczuH]

Hello!
Can i tackle this issue? @joeribekker

Looks like drf-spectacular doesn't have any automatic introspection for response headers. Apparently it was only intended as @extend_schema as per discussion here: tfranzel/drf-spectacular#283

I assume you do not want to maintain Location header in @extend_schema for each create view. Since AutoSchema is already subclassed does it make sense to extend it with introspection for HTTP 201 response and serializers containing url field which would result in Location header added to schema?

[joeribekker]

Sure!

[joeribekker]

@sergei-maertens to answer your technical question

I assume you do not want to maintain Location header in @extend_schema for each create view

[sergei-maertens]

I assume you do not want to maintain Location header in @extend_schema for each create view. Since AutoSchema is already subclassed does it make sense to extend it with introspection for HTTP 201 response and serializers containing url field which would result in Location header added to schema?

Very good assumption - your proposed approach sounds good!