Merge pull request #757 from metosin/doc/multipart-middleware-order
Some checks failed
testsuite / Clojure (Java 11) (push) Has been cancelled
testsuite / Clojure (Java 17) (push) Has been cancelled
testsuite / Clojure (Java 21) (push) Has been cancelled
testsuite / ClojureScript (push) Has been cancelled
testsuite / Lint cljdoc.edn (push) Has been cancelled
testsuite / Check cljdoc analysis (push) Has been cancelled

doc: multipart-middleware should be after coerce-request-middleware
This commit is contained in:
Joel Kaasinen 2025-10-10 13:04:57 +03:00 committed by GitHub
commit 10700e0ca2
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -58,7 +58,10 @@
"Creates a Middleware to handle the multipart params, based on "Creates a Middleware to handle the multipart params, based on
ring.middleware.multipart-params, taking same options. Mounts only ring.middleware.multipart-params, taking same options. Mounts only
if endpoint has `[:parameters :multipart]` defined. Publishes coerced if endpoint has `[:parameters :multipart]` defined. Publishes coerced
parameters into `[:parameters :multipart]` under request." parameters into `[:parameters :multipart]` under request.
Note! You want to have multipart-middleware after coerce-request-middleware,
because coerce-request-middleware overwrites `:parameters`."
([] ([]
(create-multipart-middleware nil)) (create-multipart-middleware nil))
([options] ([options]
@ -69,5 +72,8 @@
"Middleware to handle the multipart params, based on "Middleware to handle the multipart params, based on
ring.middleware.multipart-params, taking same options. Mounts only ring.middleware.multipart-params, taking same options. Mounts only
if endpoint has `[:parameters :multipart]` defined. Publishes coerced if endpoint has `[:parameters :multipart]` defined. Publishes coerced
parameters into `[:parameters :multipart]` under request." parameters into `[:parameters :multipart]` under request.
Note! You want to have multipart-middleware after coerce-request-middleware,
because coerce-request-middleware overwrites `:parameters`."
(create-multipart-middleware)) (create-multipart-middleware))