Is there a way how to document path or query params with Swagger? I have API like this :query-params [{approved :- s/Bool true}] so is it possible to document it?

@petr.mensik you can add documentation to the type via ring-swagger, see here: https://github.com/metosin/ring-swagger#adding-description-to-schemas

and there is a describe in compojure.api.sweet for this.

here’s an example: https://github.com/metosin/compojure-api/blob/c2274ee56334f9bfae05d69c4311cb95d18626fc/examples/thingie/src/examples/thingie.clj#L56

Cool, thank you, however I cannot get it work the way I want. My param is like this :query-params [approved :- (describe s/Bool "Desc" :required false :default true)] - what I want is to fallback to true if the client won't provide the param. However I am getting back exception message with missing-required-key when I don't provide it

However Swagger docs is correct, drop down also allows to enter empty value and true is the default

:query-params [{approved :- (describe s/Bool "Desc") true}] you should use describe together with letk default binding

describe can generate correct JSON-Schema for required and default properties, but it doesn't affect Schema validation on Clojure side

ahaaa, thanks a lot 🙂 sorry for beginner questions, it's still sometimes hard to read others code