jdoc 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb5a3ecf6efe4159359cb3af033ee6868e3c0cca
-  data.tar.gz: 8c97de826e81bac0954ab8b0408f04d88e139659
+  metadata.gz: d15231d47a686a9226e686f608bed11b376f3368
+  data.tar.gz: 05a43e5ce89ec70fc444f7861fb9eec825f3990f
 SHA512:
-  metadata.gz: cee439881c04f9ff975c75a1a4ea7240c8b4e9a6c07b256eb8433fb86286cbe3ffc43321d9c379d30ccb8f7c5fa981f512d9fdadb9950fb01b5e0a92084041df
-  data.tar.gz: b1cf5714cd6046acc0e77aaa08ff0c4d77ee1ec09cec5c6baf9dca78bb065da899f449ba9d5a406018fbb707d4a4fdab62749d3ac487c1ed91e64f122150bcc7
+  metadata.gz: 23cce94dbe1d36ae3524d3fe06e7626a7ce79fffc87ac089041cac4521197ee301407226aa01de4dc6bc28da93a22e0eb6a18978a7092e41c39296377335f4a5
+  data.tar.gz: 10c0212757b32120bef86909438ae78f15e198733bd49c4ab9ecffbb1cce1a876b476e603a04927911d12c68822888e5a8f9eafb165b2e78839fd6a995fff50f

data/CHANGELOG.md

@@ -1,87 +1,90 @@
+## 0.4.2
+- Show reason phrase in response example (Thx @minodisk)
+
 ## 0.4.1
-* Use 204 for `mediaType: "null"`
+- Use 204 for `mediaType: "null"`
 
 ## 0.4.0
-* Recognize `mediaType: 'null'` as "No response body"
+- Recognize `mediaType: 'null'` as "No response body"
 
 ## 0.3.4
-* Treat empty request parameters as no request body
+- Treat empty request parameters as no request body
 
 ## 0.3.3
-* Improve pattern format in properties section
+- Improve pattern format in properties section
 
 ## 0.3.2
-* Add generator options to change template
-* Add request parameters for each endpoint
+- Add generator options to change template
+- Add request parameters for each endpoint
 
 ## 0.3.1
-* Add error handling for ExampleNotFound
+- Add error handling for ExampleNotFound
 
 ## 0.3.0
-* Change example response status and body to PUT & DELETE requests
-* Improve request path example by resolving variable in path
+- Change example response status and body to PUT & DELETE requests
+- Improve request path example by resolving variable in path
 
 ## 0.2.1
-* Support multipart/form-data
+- Support multipart/form-data
 
 ## 0.2.0
-* Show schema description on docs if exists
+- Show schema description on docs if exists
 
 ## 0.1.9
-* Support property that has no type
+- Support property that has no type
 
 ## 0.1.8
-* Support property that is an array of primitive values
+- Support property that is an array of primitive values
 
 ## 0.1.7
-* Support query string example in GET request
-* Improve the description property visibility
+- Support query string example in GET request
+- Improve the description property visibility
 
 ## 0.1.6
-* Disable `<em>` feature of Redcarpet
+- Disable `<em>` feature of Redcarpet
 
 ## 0.1.5
-* Fix ToC link on HTML docs
+- Fix ToC link on HTML docs
 
 ## 0.1.4
-* Provide :html option to render docs in HTML
+- Provide :html option to render docs in HTML
 
 ## 0.1.3
-* Use its pointer name if a resource has no title property
+- Use its pointer name if a resource has no title property
 
 ## 0.1.2
-* Use .schema property for request body if exists
-* Improve array resource handling
+- Use .schema property for request body if exists
+- Improve array resource handling
 
 ## 0.1.1
-* Support has-one relation
+- Support has-one relation
 
 ## 0.1.0
-* Show resources which have no links
+- Show resources which have no links
 
 ## 0.0.9
-* Support array property
+- Support array property
 
 ## 0.0.8
-* Fix resource equality
+- Fix resource equality
 
 ## 0.0.7
-* Support `false` & `null` example value
+- Support `false` & `null` example value
 
 ## 0.0.6
-* Use root API endpoint at example response
+- Use root API endpoint at example response
 
 ## 0.0.5
-* Remove dependency on multi_json
+- Remove dependency on multi_json
 
 ## 0.0.4
-* Support whitespace and multiple templates in href
+- Support whitespace and multiple templates in href
 
 ## 0.0.3
-* Fix missing gem dependencies
+- Fix missing gem dependencies
 
 ## 0.0.2
-* Remove dependency on rack-spec
+- Remove dependency on rack-spec
 
 ## 0.0.1
-* 1st Release
+- 1st Release

data/example-api-documentation.md

@@ -60,8 +60,9 @@ Host: api.example.com
 ```
 
 ```
-HTTP/1.1 201
+HTTP/1.1 201 Created
 Content-Type: application/json
+
 {
   "id": "01234567-89ab-cdef-0123-456789abcdef",
   "name": "example",
@@ -87,7 +88,7 @@ Host: api.example.com
 ```
 
 ```
-HTTP/1.1 204
+HTTP/1.1 204 No Content
 ```
 
 ### GET /apps/:id
@@ -99,8 +100,9 @@ Host: api.example.com
 ```
 
 ```
-HTTP/1.1 200
+HTTP/1.1 200 OK
 Content-Type: application/json
+
 {
   "id": "01234567-89ab-cdef-0123-456789abcdef",
   "name": "example",
@@ -126,8 +128,9 @@ Host: api.example.com
 ```
 
 ```
-HTTP/1.1 200
+HTTP/1.1 200 OK
 Content-Type: application/json
+
 [
   {
     "id": "01234567-89ab-cdef-0123-456789abcdef",
@@ -166,8 +169,9 @@ Host: api.example.com
 ```
 
 ```
-HTTP/1.1 200
+HTTP/1.1 200 OK
 Content-Type: application/json
+
 {
   "id": "01234567-89ab-cdef-0123-456789abcdef",
   "name": "example",
@@ -205,8 +209,9 @@ Content-Disposition: form-data; name="[file]"
 ```
 
 ```
-HTTP/1.1 201
+HTTP/1.1 201 Created
 Content-Type: application/json
+
 {
   "id": "01234567-89ab-cdef-0123-456789abcdef",
   "name": "example",
@@ -241,8 +246,9 @@ Host: api.example.com
 ```
 
 ```
-HTTP/1.1 200
+HTTP/1.1 200 OK
 Content-Type: application/json
+
 [
   {
     "name": "Sushi",

data/lib/jdoc/link.rb

@@ -172,6 +172,18 @@ module Jdoc
       end
     end
 
+    # @return [String] Preferred respone reason phrase for this endpoint
+    def response_reason_phrase
+      case
+      when method == "POST"
+        "Created"
+      when has_response_body?
+        "OK"
+      else
+        "No Content"
+      end
+    end
+
     # @return [JsonSchema::Schema] Response schema for this link
     def response_schema
       @raw_link.target_schema || @raw_link.parent

data/lib/jdoc/version.rb

@@ -1,3 +1,3 @@
 module Jdoc
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
 end

data/template.md.erb

@@ -46,9 +46,9 @@ Host: <%= schema.host_with_port %>
 ```
 
 ```
-HTTP/1.1 <%= link.response_status %>
+HTTP/1.1 <%= link.response_status %> <%= link.response_reason_phrase %>
 <%= "Content-Type: application/json" if link.has_response_body? -%>
-<%= "\n#{link.response_body}\n" if link.has_response_body? -%>
+<%= "\n\n#{link.response_body}\n" if link.has_response_body? -%>
 ```
 
 <% end %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jdoc
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-09 00:00:00.000000000 Z
+date: 2015-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport