Defining a file upload endpoint

[tiholic]

I'm trying to define an endpoint which is a pure file upload API and doesn't depend on a model

swagger ref: https://swagger.io/docs/specification/describing-request-body/file-upload/#multipart

Tried setting this, but seems like I'm missing something.

@extend_schema(
  request={
    'multipart/form-data': { 'schema': ... }  # similar to what's in the above link
  }
)

[tfranzel]

hi!

i skipped this on purpose initially, because it's only well defined when used with a MIME type listing. basic annotation (e.g. bytes) has been possible though:

drf-spectacular/tests/test_extend_schema.py

Lines 192 to 199 in b35b4bf

	@extend_schema(
	request={
	'application/json': dict,
	'application/pdf': bytes,
	'text/html': OpenApiTypes.STR
	},
	responses=None
	)

i added this now as it is in fact a missing feature. however, it will only work for @extend_schema(request={MIME: {SCHEMA}}) and NOT for @extend_schema(request={SCHEMA}). turns out this also creates parity again with responses=, so it's the right thing to do.

[tiholic]

Wonderful! Thanks. It works very well.

Here's how I use it for defining file uploads using multipart:

extend_schema(
        operation_id='upload_file',
        request={
            'multipart/form-data': {
                'type': 'object',
                'properties': {
                    'file': {
                        'type': 'string',
                        'format': 'binary'
                        }
                    }
                }
            },
        )

I believe these 2 doc strings can be updated:
https://github.com/tfranzel/drf-spectacular/blob/master/drf_spectacular/utils.py#L230
https://github.com/tfranzel/drf-spectacular/blob/master/drf_spectacular/utils.py#L217

[tfranzel]

awesome!

good point. updated the doc strings.