OpenAPI-Specification icon indicating copy to clipboard operation
OpenAPI-Specification copied to clipboard

Is it possible to indicate the requiredness of a `multipart/form-data`'s request's `filename` directive?

Open TomerAberbach opened this issue 9 months ago • 7 comments

As far as I can tell, the required property in the OpenAPI spec can be used to specify that an entire multipart/form-data part is required, but it cannot be used to indicate whether the filename directive is required.

This would be pretty useful since some multipart/form-data endpoints require the filename directive while others do not. If OpenAPI allowed specifying those semantics, then that could be used in various generators that consume OpenAPI (e.g. an SDK generator could check whether the end-user supplied a filename if it's required).

TomerAberbach avatar Mar 15 '25 22:03 TomerAberbach

You are right as of today there is no way no manipulate the content disposition , this would be something to add in OAS 3.2 or 3.+

adding RFC link for the record (https://www.rfc-editor.org/rfc/rfc7578#section-4.3)

LasneF avatar Mar 19 '25 08:03 LasneF

Thanks for confirming!

Is there anything I can do to help with getting it into the spec?

TomerAberbach avatar Mar 19 '25 13:03 TomerAberbach

@TomerAberbach this woul likely go into 3.3 as part of a larger revamp/streamlining of data modeling. The way that form and/or multipart data is managed is a complex and rickety set of features that weren't all designed together, so we neeed to do something bigger than will fit in the 3.2 time frame. See #4210 for release planning details, as well as #1502 for some history on data modeling problems.

Unfortunately, revamping data modeling is a bit of a big/historically burdened topic to just jump on immediately.

handrews avatar Mar 19 '25 16:03 handrews

Cool, that makes sense!

I'm happy to get involved here if you think it'd be helpful, but if you already have a handle on this revamp, then I'll leave it to you :)

TomerAberbach avatar Mar 19 '25 19:03 TomerAberbach

@TomerAberbach we probably won't get to it until the summer, as we need to get 3.2 out the door (or at least mostly finished) first.

handrews avatar Mar 19 '25 19:03 handrews

Noted. Let me know if you need any more info from me when the time comes

TomerAberbach avatar Mar 19 '25 19:03 TomerAberbach

Kind of related to #2458 and #2342

baywet avatar Sep 25 '25 16:09 baywet