jdoc 0.1.9 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ede1c30d5aff68f2e68e3f3283716f70ce53c7de
-  data.tar.gz: df42a4a13574f2e80feb9e500c6f1612ceeed49c
+  metadata.gz: c55cb2cd6e9fb7c413955cb27466ea7166210666
+  data.tar.gz: 4dd21023b7af214e1eb448d3bd3410e00e4a0e36
 SHA512:
-  metadata.gz: 2a6444702d84d35bc36cf9353ea73523384f9ea6ff856771d4e3f6e7276480b4b0b143063e32624501c4b9317164503b5dde4c53db186d68a00e2bd28a8eb0d0
-  data.tar.gz: a8447fcd1cb335b41b571ffa55fe8b6bcae0be1839dea092325ead4523a43c2eb96a8a6b8f97063d85dc445de59dc9474b9f2c9dec6ae8853aa6903cb3814c14
+  metadata.gz: cd723d33c3bfeff779db5a8725829c4895d38a63c7ea6ee787a6c31d6879e95c0e41577975115f2c8688f874325b9f6d353777e43451d6375e275f369654f0cb
+  data.tar.gz: daba310565e86e8d309582676311b396a76bccbf48b9e4c932b0d616107db36c2d92a66ce62c26df4f1ad4bd00726f526f8fcba9ce7f188c8a07739fb568f1b6

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.2.0
+* Show schema description on docs if exists
+
 ## 0.1.9
 * Support property that has no type
 

data/example-api-documentation.md

@@ -1,4 +1,5 @@
 # Example API
+A schema for a small example API.
 * [App](#app)
  * [POST /apps](#post-apps)
  * [DELETE /apps/:id](#delete-appsid)

data/lib/jdoc/schema.rb

@@ -21,6 +21,15 @@ module Jdoc
       @json_schema.title
     end
 
+    # @return [String, nil] Description property of this schema
+    # @example
+    #   schema.description #=> "A schema for a small example API."
+    def description
+      if @json_schema.description
+        "#{@json_schema.description}\n\n"
+      end
+    end
+
     # @return [String]
     # @example
     #   host_with_port #=> "api.example.com"

data/lib/jdoc/version.rb

@@ -1,3 +1,3 @@
 module Jdoc
-  VERSION = "0.1.9"
+  VERSION = "0.2.0"
 end

data/template.md.erb

@@ -1,4 +1,5 @@
 # <%= schema.title || "API" %>
+<%= schema.description -%>
 <% schema.resources.each do |resource| %>
 * <%= resource.hyperlink %>
 <% resource.links.each do |link| %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jdoc
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-27 00:00:00.000000000 Z
+date: 2014-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport