Merge branch 'master' of github.com:metosin/ring-swagger

Author: ikitommi

.gitignore

@@ -13,3 +13,4 @@ bower_components
 *.log
 **/#*
 .#*
+gh-pages

README.md

@@ -2,6 +2,7 @@
 
 [Swagger](http://swagger.io/) implementation for Clojure/Ring using [Prismatic Schema](https://github.com/Prismatic/schema) for data modeling. 
 
+- [API Docs](http://metosin.github.io/ring-swagger/doc/)
 - Supports both 1.2 and 2.0 Swagger Specs
 - For web developers
   - Extendable Schema->JSON Mappings with out-of-the-box support for most common types
@@ -24,6 +25,7 @@
 - [Compojure-Api](https://github.com/metosin/compojure-api) for Compojure
 - [fnhouse-swagger](https://github.com/metosin/fnhouse-swagger) for fnhouse
 - [pedastal-swagger](https://github.com/frankiesardo/pedestal-swagger) for Pedastal
+- [yada](https://github.com/juxt/yada)
 
 Route definitions as expected as a clojure Map defined by the [Schema](https://github.com/metosin/ring-swagger/blob/master/src/ring/swagger/swagger2_schema.clj). The Schema is open as ring-swagger tries not to be on your way - one can always pass any extra data in the Swagger Spec format.
 

project.clj

@@ -18,12 +18,17 @@
                  [org.flatland/ordered "1.5.2"]]
   :profiles {:dev {:plugins [[lein-clojars "0.9.1"]
                              [lein-ring "0.9.4"]
-                             [lein-midje "3.1.3"]]
+                             [lein-midje "3.1.3"]
+                             [funcool/codeina "0.1.0"]]
                    :dependencies [[midje "1.7.0-SNAPSHOT"]
                                   [ring-mock "0.1.5"]
                                   [metosin/scjsv "0.2.0"]
                                   [metosin/ring-swagger-ui "2.0.24"]
                                   [javax.servlet/servlet-api "2.5"]]}
              :1.7 {:dependencies [[org.clojure/clojure "1.7.0-alpha4"]]}}
+  :codeina {:sources ["src"]
+            :output-dir "gh-pages/doc"
+            :src-dir-uri "http://github.com/metosin/ring-swagger/blob/master/"
+            :src-linenum-anchor-prefix "L" }
   :aliases {"all" ["with-profile" "dev:dev,1.7"]
             "test-ancient" ["midje"]})

scripts/build-docs.sh

@@ -0,0 +1,31 @@
+#!/bin/bash
+
+rev=$(git rev-parse HEAD)
+remoteurl=$(git ls-remote --get-url origin)
+
+git fetch
+if [[ -z $(git branch -r --list origin/gh-pages) ]]; then
+    (
+    mkdir gh-pages
+    cd gh-pages
+    git init
+    git remote add origin ${remoteurl}
+    git checkout -b gh-pages
+    git commit --allow-empty -m "Init"
+    git push -u origin gh-pages
+    )
+elif [[ ! -d gh-pages ]]; then
+    git clone --branch gh-pages ${remoteurl} gh-pages
+else
+    (
+    cd gh-pages
+    git pull
+    )
+fi
+
+mkdir -p gh-pages/doc
+lein doc
+cd gh-pages
+git add --all
+git commit -m "Build docs from ${rev}."
+git push origin gh-pages

src/ring/swagger/common.clj

@@ -24,9 +24,11 @@
 
 (defn extract-parameters
   "Extract parameters from head of the list. Parameters can be:
-     1) a map (if followed by any form) [{:a 1 :b 2} :body] => {:a 1 :b 2}
-     2) list of keywords & values   [:a 1 :b 2 :body] => {:a 1 :b 2}
-     3) else => {}
+
+   1. a map (if followed by any form) `[{:a 1 :b 2} :body]` => `{:a 1 :b 2}`
+   2. list of keywords & values `[:a 1 :b 2 :body]` => `{:a 1 :b 2}`
+   3. else => `{}`
+
    Returns a tuple with parameters and body without the parameters"
   [c]
   {:pre [(sequential? c)]}

src/ring/swagger/json_schema_dirty.clj

@@ -1,4 +1,6 @@
 (ns ring.swagger.json-schema-dirty
+  "Json-type multimethod implementations for some Schemas which can't be
+   properly described using Json Schema."
   (:require [ring.swagger.json-schema :refer :all]))
 
 (defmethod json-type schema.core.ConditionalSchema [e]

src/ring/swagger/ui.clj

@@ -25,9 +25,10 @@
    default is to serve swagger-ui at \"/\".
 
    Other options can be given using keyword-value pairs.
-   :root - the root prefix to get resources from. Default 'swagger-ui'
-   :swagger-docs - the endpoint to get swagger data from. Default '/swagger.json'
-   :oauth2 - map with oauth2 params, namely :client-id, :realm and :app-name"
+
+   - **:root** the root prefix to get resources from. Default 'swagger-ui'
+   - **:swagger-docs** the endpoint to get swagger data from. Default '/swagger.json'
+   - **:oauth2** map with oauth2 params, namely `:client-id`, `:realm` and `:app-name`"
   [& params]
   (let [[path kvs] (if (string? (first params))
                      [(first params) (rest params)]