OAI / OAI/OpenAPI-Specification
Is it possible to indicate the requiredness of a `multipart/form-data`'s request's `filename` directive?
Nobody has claimed this yet.
- Dominant language
- Markdown
- Stars
- 31.2k
- Forks
- 9.2k
- Avg merge
- 6h 37m
- Merged PRs (30d)
- 27
Description
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).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the OpenAPI multipart/form-data requirements and the linked Content-Disposition filename definition. Determine how required filename semantics could be represented for consumers such as SDK generators, and define completion through an agreed specification change with corresponding examples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100