OAI / OAI/OpenAPI-Specification
Callbacks runtime expressions in multipart bodies
Nobody has claimed this yet.
- Dominant language
- Markdown
- Stars
- 31.2k
- Forks
- 9.2k
- Avg merge
- 6h 37m
- Merged PRs (30d)
- 27
Description
Hi,
In the OpenAPI spec, when defining a Callback Object, you can use a runtime expression in the form of:
$request.body#...
What goes after "body" should be a JSON pointer expression.
However, when the HTTP request contains a multipart body, I fail to see how to reference a specific body part, where the JSON pointer expression is to be applied.
Any hint on how to express this in OpenAPI?
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 with the linked OpenAPI 3.0.2 Callback Object and runtime expressions sections, then compare their definition of $request.body with multipart request bodies. Determine whether a multipart part can be addressed by the existing JSON Pointer form; done means the specification clearly documents the supported expression or identifies the required specification change.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100