-
Notifications
You must be signed in to change notification settings - Fork 2.7k
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
MultiPartConfig in HTTP Vert.x extension is insufficiently documented #30046
Comments
/cc @FroMage(resteasy-reactive), @geoand(resteasy-reactive), @stuartwdouglas(resteasy-reactive) |
/cc @pedroigor @gsmet as you were participating on the PR. |
You are right, I totally missed this... We probably do need to mention that it only works for RESTEasy Reactive (currently) |
And the fix for this issue needs to be back-ported to 2.13 branch as #29729 was back-ported to 2.13.6.Final |
@geoand Do you want me to make the change? |
@pedroigor sure, that would be nice |
I'm trying to improve the documentation for the option:
I'm kinda stuck trying to explain that it only works for RR because the setting (as mentioned by @michalvavrik) is a top-level HTTP setting. Looks like the right thing to do is to deprecate this one and move the option to RR, but I'm not sure if we can fix that now ... Otherwise, if you think we can just mention RR in the documentation above it works for me too. |
Yeah, I think it's too late for that.
I'm fine with this |
@geoand @michalvavrik Not ideal. Can you please check if it is better [1]? [1] #30214 |
Describe the bug
Hello,
I have one opinion (you can ignore that one) and one concern (IMO bug) regarding #29729 documentation.
Opinion: Please document this feature in more detail and ideally provide an example in docs. Documentation does not provide single example on
MultiPartConfig
andfileContentTypes
. I understand you (and me) know whatMultiPartConfig#fileContentType
should be used for because we read this PR, but users didn't not, they only see this configuration property with textA list of {@code ContentType} to indicate whether a given multipart field should be handled as a file part.
With context of #29729 that sentence is completely clear, but you can only find this in configuration properties list.
Concern This PR added
MultiPartConfig
to Vert.x HTTP extension.MultiPartConfig
only used by RESTEasy Reactive and ignored by every other extension (RESTEasy Classic, Reactive Routes, ...) while that fact is literally nowhere mentioned.How is it possible to have the configuration in Vert.X HTTP extension and do not mention it only works for RESTEasy Reactive? How should user know that?
Expected behavior
one of:
MultiPartConfig#fileContentType
configuration property works for RESTEasy Classic, Reactive Routes etc.Actual behavior
How to Reproduce?
No response
Output of
uname -a
orver
No response
Output of
java -version
No response
GraalVM version (if different from Java)
No response
Quarkus version or git rev
No response
Build tool (ie. output of
mvnw --version
orgradlew --version
)No response
Additional information
No response
The text was updated successfully, but these errors were encountered: