Documenting request body

[dzhus]

With compojure-api-0.24.0, specifying documentation for body schema with

:body [body (describe {:articles [Article]} "New content")]

for a route does not produce any documentation for body parameter in swagger spec.

[ikitommi]

hi. does the s/named work with that?

[vincentbernat]

Hey!

I run into the same problem: no description. Using s/named doesn't change anything:

:body [log (s/named schema/LogEntry "log entry to append")]

Also, is it possible to give a name to this "parameter" instead of "Body24502"?

[ikitommi]

should be possible. will check this one out.

[ikitommi]

Sorry for taking so long.

Naming an anonymous body schema:

(POST "/some" []
  :body [body (s/schema-with-name {:kikka String} "Kikka")]
  (ok body))

Adding description to body schema fixed in 1.1.0-SNAPSHOT:

(POST "/some" []
  :body [body (describe {:kikka String} "this is kikka")]
  (ok body))

Together:

(POST "/some" []
  :body [body (describe (s/schema-with-name {:kikka String} "Kikka") "this is kikka")]
  (ok body))

After implementing this feature, can add support for more declarative schemas.

[dzhus]

Thanks!