How to provide examples for in multipart/form-data?

[kiran-4444]

    @extend_schema(
        request={
            "multipart/form-data": {
                "type": "object",
                "properties": {
                    "project_id": {
                        "type": "string",
                        "description": "ID of the project.",
                        "default": "5",
                        "required": True,
                        'in': 'body',
                    },
                    "input": {
                        "type": "string",
                        "format": "binary",
                        "description": "Input file.",
                        "required": True,
                        'in': 'body',
                    },
                },
            },
        },
        examples=[
            OpenApiExample(
                "Example",
                summary="Example",
                description="Example",
                value={
                    "project_id": "5",
                },
                request_only=True,
            ),
        ]
    )
    def post(self, request, *args, **kwargs):

I have this, when I try to make the form type to application/json the example works but it's not working when I change it back to multipart/form-data.

[tfranzel]

Hi, it does not show up because the example is on the view level and the default value for media_type does not match

drf-spectacular/drf_spectacular/utils.py

Line 142 in 3dd27b0

- media_type will default to 'application/json' unless implicitly specified

We are actually introducing OpenApiRequest right now in #966 where the media_type would be autofilled, since you would mount the example under multipart/form-data

---

                    'in': 'body',

I don't think this is legal OpenApi 3.0.3. Afaik in on exists on parameters

[kiran-4444]

I didn't quite get it. Can you elaborate? Thanks!

[tfranzel]

            OpenApiExample(
                "Example",
                summary="Example",
                description="Example",
                value={
                    "project_id": "5",
                },
                request_only=True,
                media_type="multipart/form-data"  # <<<<<<<
            ),

is the solution right now.

When we merge #966, you don't need to specify request_only and media_type when used with

@extend_schema(
    request={
        "multipart/form-data":  OpenApiRequest(
            {...your raw schema}, 
            examples=[OpenApiExample(...)]
        )
    }
)

[tfranzel]

closing this issue for now. feel free to comment if anything is missing or not working and we will follow-up.