jdoc 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df300f30d95d8a3f3ed9ea1e2a3c0848818c328a
-  data.tar.gz: 00954109d3497003c916b9c5e6a8bc1015838b73
+  metadata.gz: 6327b02b6a01126e085de598704c28f6187903ba
+  data.tar.gz: 909c4b63a36d9631d70b2ec7bb98b387f5d11870
 SHA512:
-  metadata.gz: c1b786485026d48129e096a64f5398adf78e611db540e31fbaf53294e64ea28915be3739f399bf63200dccffd6e05eef3b15cb46b75044c71310834da91b7f3f
-  data.tar.gz: 0c563787a3846f4505ecf5b81d46a9a5eed786a35bea5b7c4980807ebee68bf93a59fa02cd47fd1675d430289bbaff8acf79f031f070cbc05274af74769643e5
+  metadata.gz: 3d8b8189400dbc6bea3986cc7f507ce588ca8eeb3cb6d34272275905332c10688f9f6f2a7e5a5e084fdfddfa333b1be1128378eebc5fdbaaa211dc67b247a775
+  data.tar.gz: 8fdf1d2c6790eccb6f500b8de15483640510a024904b6a8b7c4248ed7b0b3fa6619a4eb3aebbc711f219c237f082a16cef2668a63c99e485de57f873f41043d1

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.1.7
+* Support query string example in GET request
+* Improve the description property visibility
+
 ## 0.1.6
 * Disable `<em>` feature of Redcarpet
 

data/example-api-documentation.md

@@ -13,22 +13,26 @@
 An app is a program to be deployed.
 
 ### Properties
-* id - unique identifier of app
+* id
+ * unique identifier of app
  * Example: `"01234567-89ab-cdef-0123-456789abcdef"`
  * Type: string
  * Format: uuid
  * ReadOnly: true
-* name - unique name of app
+* name
+ * unique name of app
  * Example: `"example"`
  * Type: string
  * Patern: `(?-mix:^[a-z][a-z0-9-]{3,50}$)`
-* private - true if this resource is private use
+* private
+ * true if this resource is private use
  * Example: `false`
  * Type: boolean
-* deleted_at - When this resource was deleted at
+* deleted_at
+ * When this resource was deleted at
  * Example: `nil`
  * Type: null
-* users - 
+* users
  * Type: array
 
 ### POST /apps
@@ -172,10 +176,10 @@ Content-Type: application/json
 
 
 ### Properties
-* name - 
+* name
  * Example: `"Sushi"`
  * Type: string
-* user - 
+* user
  * Type: object
 
 ### GET /recipes
@@ -204,7 +208,7 @@ Content-Type: application/json
 
 
 ### Properties
-* name - 
+* name
  * Example: `"alice"`
  * Type: string
 

data/lib/jdoc.rb

@@ -1,3 +1,4 @@
+require "active_support/core_ext/object/to_query"
 require "active_support/core_ext/string/inflections"
 require "cgi"
 require "erubis"

data/lib/jdoc/link.rb

@@ -62,9 +62,30 @@ module Jdoc
       end
     end
 
+    # Adds query string if a link has a schema property and method is GET
+    # @return [String, nil] A query string prefixed with `?` only to GET request
+    # @example
+    #   link.query_string #=> "?type=Recipe"
+    def query_string
+      if method == "GET" && !request_parameters.empty?
+        "?#{request_parameters.to_query}"
+      end
+    end
+
     # @return [String, nil] Example request body in JSON format
     def request_body
-      JSON.pretty_generate(RequestGenerator.call(request_schema.properties)) + "\n"
+      JSON.pretty_generate(request_parameters) + "\n"
+    end
+
+    # @return [Hash] Example request parameters for this endpoint
+    def request_parameters
+      @request_parameters ||= begin
+        if has_schema_in_link?
+          RequestGenerator.call(request_schema.properties)
+        else
+          {}
+        end
+      end
     end
 
     # @return [true, false] True if this endpoint must have request body
@@ -101,6 +122,11 @@ module Jdoc
 
     private
 
+    # @return [true, false] True if a given link has a schema property
+    def has_schema_in_link?
+      !!@raw_link.schema
+    end
+
     # @return [true, false] True if response is intended to be list data
     def has_list_data?
       @raw_link.rel == "instances"

data/lib/jdoc/version.rb

@@ -1,3 +1,3 @@
 module Jdoc
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

data/template.md.erb

@@ -12,7 +12,10 @@
 
 ### Properties
 <% resource.properties.each do |property| %>
-* <%= property.name %> - <%= property.description %>
+* <%= property.name %>
+<% if property.description %>
+ * <%= property.description %>
+<% end %>
 <% property.options.each do |key, value| %>
  * <%= key %>: <%= value %>
 <% end %>
@@ -23,7 +26,7 @@
 <%= link.description %>
 
 ```
-<%= link.method %> <%= link.path %> HTTP/1.1
+<%= link.method %> <%= link.path %><%= link.query_string %> HTTP/1.1
 <%= "Content-Type: application/json\n" if link.has_request_body? -%>
 Host: <%= schema.host_with_port %>
 <%= "\n" + link.request_body if link.has_request_body? -%>

metadata

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