How to set Redirect response

[KStenK]

Hello,

I'm using DRF APIView and I want to show 301 redirects and redirect location in swagger-ui.

I can add a status code like this:

@extend_schema(responses={301: None})

But how can I set the response header and add the header: Location: /.

I thought i can do something like this:

@extend_schema(responses={301: {"headers": {"Location": "/"}}

To get schema something like this:

responses:
  '301':
    headers:
      Location: /

But that does not work.

Is there any way I can do that or how should I customize responses to set headers/cookies with extend_schema?

[tfranzel]

@KStenK that feature is not implemented yet. there is currently no direct access for this. we will definitely add this

@sergei-maertens has volunteered to implement this feature in #283. are you still working on this?

[sergei-maertens]

It's still on my todo list, but I've been swamped with more urgent things. I'll plan some time at the end of the day to get a PR going!

[tfranzel]

@KStenK feature is now available. see here for usage:

drf-spectacular/tests/test_extend_schema.py

Lines 108 to 114 in d76c310

	OpenApiParameter(
	name='Location',
	type=OpenApiTypes.URI,
	location=OpenApiParameter.HEADER,
	description='URL of the created resource',
	response=[201],
	),

[KStenK]

I don't know what I do wrong, but for me, it does not work.

Here is what have I tried:

@extend_schema(
  responses={301: None},
  tags=["Registration"],
  parameters=[
      OpenApiParameter(
          name="Location",
          type=OpenApiTypes.URI,
          location=OpenApiParameter.HEADER,
          description="/",
          response=[301]
      )
  ])

Schema generated:

    get:
       . . .
      responses:
        '301':
          description: No response body

Swagger UI:

[tfranzel]

@KStenK but now it should work. we did not account for the empty body case.

[KStenK]

Now looks fine for me :)

[KStenK]

Is there a new version with that feature out too at pip soon?

[tfranzel]

i have to fix 2 other issues first. next release is probably next week.