1.1.11

Author: ikitommi

CHANGELOG.md

@@ -1,5 +1,22 @@
 ## Unreleased
 
+## 1.1.11 (25.7.2017)
+
+ * **BREAKING**: in `compojure.api.swagger`, the `swagger-ui` and `swagger-docs` now take options map with `path` key instead of separate optional path & vararg opts.
+   - normally you would use swagger api-options or `swagger-routes` and thus be unaffected of this.
+
+* updated dependencies:
+
+```clj
+[prismatic/plumbing "0.5.4"] is available but we use "0.5.3"
+[cheshire "5.7.1"] is available but we use "5.6.3"
+[compojure "1.6.0"] is available but we use "1.5.2"
+[prismatic/schema "1.1.6"] is available but we use "1.1.3"
+[ring-middleware-format "0.7.2"] is available but we use "0.7.0"
+[metosin/ring-http-response "0.9.0"] is available but we use "0.8.1"
+[metosin/ring-swagger "0.24.1"] is available but we use "0.22.14"
+```
+
 ## 1.1.10 (11.1.2017)
 
 * Updated dependencies to [avoid a path traversal vulnerability](https://groups.google.com/forum/#!topic/clojure/YDrKBV26rnA) in Ring.

project.clj

@@ -5,16 +5,16 @@
             :url "http://www.eclipse.org/legal/epl-v10.html"
             :distribution :repo
             :comments "same as Clojure"}
-  :dependencies [[prismatic/plumbing "0.5.3"]
+  :dependencies [[prismatic/plumbing "0.5.4"]
                  [potemkin "0.4.3"]
-                 [cheshire "5.6.3"]
-                 [compojure "1.5.2"]
-                 [prismatic/schema "1.1.3"]
+                 [cheshire "5.7.1"]
+                 [compojure "1.6.0"]
+                 [prismatic/schema "1.1.6"]
                  [org.tobereplaced/lettercase "1.0.0"]
                  [frankiesardo/linked "1.2.9"]
-                 [ring-middleware-format "0.7.0"]
-                 [metosin/ring-http-response "0.8.1"]
-                 [metosin/ring-swagger "0.22.14"]
+                 [ring-middleware-format "0.7.2"]
+                 [metosin/ring-http-response "0.9.0"]
+                 [metosin/ring-swagger "0.24.1"]
                  [metosin/ring-swagger-ui "2.2.8"]]
   :profiles {:uberjar {:aot :all
                        :ring {:handler examples.thingie/app}
@@ -26,7 +26,7 @@
              :dev {:repl-options {:init-ns user}
                    :plugins [[lein-clojars "0.9.1"]
                              [lein-midje "3.2.1"]
-                             [lein-ring "0.9.7"]
+                             [lein-ring "0.12.0"]
                              [funcool/codeina "0.5.0"]]
                    :dependencies [[org.clojure/clojure "1.8.0"]
                                   [slingshot "0.12.2"]
@@ -44,7 +44,7 @@
                    :source-paths ["examples/thingie/src" "examples/thingie/dev-src"]
                    :main examples.server}
              :perf {:jvm-opts ^:replace []}
-             :logging {:dependencies [[org.clojure/tools.logging "0.3.1"]]}
+             :logging {:dependencies [[org.clojure/tools.logging "0.4.0"]]}
              :1.7 {:dependencies [[org.clojure/clojure "1.7.0"]]}}
   :eastwood {:namespaces [:source-paths]
              :add-linters [:unused-namespaces]}

src/compojure/api/swagger.clj

@@ -6,7 +6,7 @@
             [ring.swagger.common :as rsc]
             [ring.swagger.middleware :as rsm]
             [ring.swagger.core :as swagger]
-            [ring.swagger.ui :as rsui]
+            [ring.swagger.swagger-ui :as swagger-ui]
             [ring.swagger.swagger2 :as swagger2]
             [compojure.api.routes :as routes]))
 
@@ -28,15 +28,14 @@
        (swagger2/transform-operations routes/non-nil-routes)
        (swagger2/transform-operations routes/strip-no-doc-endpoints)))
 
-(defn swagger-ui [& params]
+(defn swagger-ui [options]
+  (assert (map? options) "Since 1.1.11, compojure.api.swagger/swagger-ui takes just one map as argument, with `:path` for the path.")
   (c/undocumented
-    (apply rsui/swagger-ui params)))
+    (swagger-ui/swagger-ui options)))
 
-(defn swagger-docs [& body]
-  (let [[path body] (if (string? (first body))
-                      [(first body) (rest body)]
-                      ["/swagger.json" body])
-        [extra-info] (common/extract-parameters body false)]
+(defn swagger-docs [{:keys [path] :or {path "/swagger.json"} :as options}]
+  (assert (map? options) "Since 1.1.11, compojure.api.swagger/swagger-docs takes just one map as argument, with `:path` for the path.")
+  (let [extra-info (dissoc options :path)]
     (c/GET path request
       :no-doc true
       :name ::swagger
@@ -57,21 +56,15 @@
 (defn swagger-routes
   "Returns routes for swagger-articats (ui & spec). Accepts an options map, with the
   following options:
-
-  **:ui**              Uri for the swagger-ui (defaults to \"/\").
+  **:ui**              Path for the swagger-ui (defaults to \"/\").
                        Setting the value to nil will cause the swagger-ui not to be mounted
-
-  **:spec**            Uri for the swagger-spec (defaults to \"/swagger.json\")
+  **:spec**            Path for the swagger-spec (defaults to \"/swagger.json\")
                        Setting the value to nil will cause the swagger-ui not to be mounted
-
   **:data**            Swagger data in the Ring-Swagger format.
-
   **:options**
     **:ui**            Options to configure the ui
     **:spec**          Options to configure the spec. Nada at the moment.
-
   Example options:
-
     {:ui \"/api-docs\"
      :spec \"/swagger.json\"
      :options {:ui {:jsonEditor true}
@@ -89,8 +82,9 @@
             :tags [{:name \"sausages\", :description \"Sausage api-set\"}]}}"
   ([] (swagger-routes {}))
   ([options]
-   (let [{:keys [ui spec data] {ui-options :ui} :options} (merge swagger-defaults options)]
+   (let [{:keys [ui spec data] {ui-options :ui} :options} (merge swagger-defaults options)
+         path (apply str (remove clojure.string/blank? [(:basePath data) spec]))]
      (if (or ui spec)
        (c/routes
-         (if ui (apply swagger-ui ui (mapcat identity (merge (if spec {:swagger-docs (apply str (remove clojure.string/blank? [(:basePath data) spec]))}) ui-options))))
-         (if spec (apply swagger-docs spec (mapcat identity data))))))))
+         (if ui (swagger-ui (merge (if spec {:swagger-docs path}) ui-options {:path ui})))
+         (if spec (swagger-docs (assoc data :path spec))))))))