Skip to content

Docs (Symfony file upload): Change order of enabled formats #2142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 14, 2025

Conversation

lucastrahlendorff
Copy link
Contributor

Having multipart at the first position of enabled formats in api_platform.yaml negatively affects the api (swagger) documentation. For some reason, all requests will be generated with 'accept: multipart/form-data', which is wrong for most endpoints. See the following GET request which is generated with the "accept: multipart/form-data" header (see the curl command below):

image

This leads to responses with the error message "Serialization for the format "multipart" is not supported.".

Switching the formats in api_platform.yaml to have jsonld at the first position solves this issue:

formats:
    jsonld: ['application/ld+json']
    multipart: ['multipart/form-data']

Now, the request is generated and done properly with the correct accept header:
image

I was also able to reproduce this in version 4.0. This fix does not seem to have any other side effects on both versions 4.0 and 4.1. Can somebody confirm this?

Greetings!

@soyuka soyuka merged commit 829cef5 into api-platform:4.1 Mar 14, 2025
1 check failed
@soyuka
Copy link
Member

soyuka commented Mar 14, 2025

thanks @lucastrahlendorff indeed probably that multipart should be added only for the operation supporting it instead of being added globally anyways.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants