jdoc 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b722b53c4f1b6c34b1391d78b3fb28e9e63d07c
-  data.tar.gz: 7cd3d992bd82307b617ebf3a763e8a485dd0df54
+  metadata.gz: 85929520c47c8da4470fd31511e2ed1fd6339c06
+  data.tar.gz: 06fe3649a261ae6c730e6f89e68ef8319a7ee0e1
 SHA512:
-  metadata.gz: 693cd1ea1963567d84e9534f81aa6160af1204e3ec929ddd17fceb0329efbbcb68ae89b1a2019b5d9595cb1b055f8fc02173e1d4e6d5950cae8b60bf1b96a848
-  data.tar.gz: c81f05a6e4b42f0af9e27db63981109c8224b23a2f53bb057189ab401901ed23c1f5258d335ee30c920e1b47f45550bb47e3b9c9906ede51f4c3819a574a3616
+  metadata.gz: 6df634d0e21e1ac4309b54a9e2999015925fcd7ba129137b4ac53029212b9f414fc46f52c27667519a641187d67c2ffb151daec085ade55212f81d974383e088
+  data.tar.gz: aba27404ae762b1822ed67d407b0baef58cf00e052cbf9bad2369eda2679e304367b678330a0943184db894d018ac4085a9c668848ff95bff218bebc04ab44ed

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.0.7
+* Support `false` & `null` example value
+
 ## 0.0.6
 * Use root API endpoint at example response
 

data/example-api-documentation.md

@@ -11,14 +11,20 @@ An app is a program to be deployed.
 
 ### Properties
 * id - unique identifier of app
- * Example: `01234567-89ab-cdef-0123-456789abcdef`
+ * Example: `"01234567-89ab-cdef-0123-456789abcdef"`
  * Type: string
  * Format: uuid
  * ReadOnly: true
 * name - unique name of app
- * Example: `example`
+ * Example: `"example"`
  * Type: string
  * Patern: `(?-mix:^[a-z][a-z0-9-]{3,50}$)`
+* private - true if this resource is private use
+ * Example: `false`
+ * Type: boolean
+* deleted_at - When this resource was deleted at
+ * Example: `nil`
+ * Type: null
 
 ### GET /apps
 List existing apps.
@@ -35,7 +41,9 @@ Content-Type: application/json
 
 {
   "id": "01234567-89ab-cdef-0123-456789abcdef",
-  "name": "example"
+  "name": "example",
+  "private": false,
+  "deleted_at": null
 }
 ```
 
@@ -48,7 +56,9 @@ Content-Type: application/json
 Host: api.example.com
 
 {
-  "name": "example"
+  "name": "example",
+  "private": false,
+  "deleted_at": null
 }
 ```
 
@@ -58,7 +68,9 @@ Content-Type: application/json
 
 {
   "id": "01234567-89ab-cdef-0123-456789abcdef",
-  "name": "example"
+  "name": "example",
+  "private": false,
+  "deleted_at": null
 }
 ```
 
@@ -77,7 +89,9 @@ Content-Type: application/json
 
 {
   "id": "01234567-89ab-cdef-0123-456789abcdef",
-  "name": "example"
+  "name": "example",
+  "private": false,
+  "deleted_at": null
 }
 ```
 
@@ -90,7 +104,9 @@ Content-Type: application/json
 Host: api.example.com
 
 {
-  "name": "example"
+  "name": "example",
+  "private": false,
+  "deleted_at": null
 }
 ```
 
@@ -100,7 +116,9 @@ Content-Type: application/json
 
 {
   "id": "01234567-89ab-cdef-0123-456789abcdef",
-  "name": "example"
+  "name": "example",
+  "private": false,
+  "deleted_at": null
 }
 ```
 
@@ -119,7 +137,9 @@ Content-Type: application/json
 
 {
   "id": "01234567-89ab-cdef-0123-456789abcdef",
-  "name": "example"
+  "name": "example",
+  "private": false,
+  "deleted_at": null
 }
 ```
 

data/lib/jdoc/property.rb

@@ -27,8 +27,8 @@ module Jdoc
 
     # @return [String, nil] Example value, defined in example property
     def example
-      if str = @schema.data["example"]
-        "`#{str}`"
+      if @schema.data.has_key?("example")
+        %<`#{@schema.data["example"].inspect}`>
       end
     end
 

data/lib/jdoc/version.rb

@@ -1,3 +1,3 @@
 module Jdoc
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/spec/fixtures/schema.yml

@@ -25,6 +25,16 @@ definitions:
         readOnly: false
         type:
         - string
+      private:
+        description: true if this resource is private use
+        example: false
+        type:
+        - boolean
+      deleted_at:
+        description: When this resource was deleted at
+        example: null
+        type:
+        - "null"
     links:
     - description: Create a new app.
       href: "/apps"
@@ -68,6 +78,10 @@ definitions:
         "$ref": "#/definitions/app/definitions/id"
       name:
         "$ref": "#/definitions/app/definitions/name"
+      private:
+        "$ref": "#/definitions/app/definitions/private"
+      deleted_at:
+        "$ref": "#/definitions/app/definitions/deleted_at"
 properties:
   app:
     "$ref": "#/definitions/app"

data/spec/jdoc/generator_spec.rb

@@ -31,14 +31,20 @@ describe Jdoc::Generator do
 
         ### Properties
         * id - unique identifier of app
-         * Example: `01234567-89ab-cdef-0123-456789abcdef`
+         * Example: `"01234567-89ab-cdef-0123-456789abcdef"`
          * Type: string
          * Format: uuid
          * ReadOnly: true
         * name - unique name of app
-         * Example: `example`
+         * Example: `"example"`
          * Type: string
          * Patern: `(?-mix:^[a-z][a-z0-9-]{3,50}$)`
+        * private - true if this resource is private use
+         * Example: `false`
+         * Type: boolean
+        * deleted_at - When this resource was deleted at
+         * Example: `nil`
+         * Type: null
 
         ### GET /apps
         List existing apps.
@@ -55,7 +61,9 @@ describe Jdoc::Generator do
 
         {
           "id": "01234567-89ab-cdef-0123-456789abcdef",
-          "name": "example"
+          "name": "example",
+          "private": false,
+          "deleted_at": null
         }
         ```
 
@@ -68,7 +76,9 @@ describe Jdoc::Generator do
         Host: api.example.com
 
         {
-          "name": "example"
+          "name": "example",
+          "private": false,
+          "deleted_at": null
         }
         ```
 
@@ -78,7 +88,9 @@ describe Jdoc::Generator do
 
         {
           "id": "01234567-89ab-cdef-0123-456789abcdef",
-          "name": "example"
+          "name": "example",
+          "private": false,
+          "deleted_at": null
         }
         ```
 
@@ -97,7 +109,9 @@ describe Jdoc::Generator do
 
         {
           "id": "01234567-89ab-cdef-0123-456789abcdef",
-          "name": "example"
+          "name": "example",
+          "private": false,
+          "deleted_at": null
         }
         ```
 
@@ -110,7 +124,9 @@ describe Jdoc::Generator do
         Host: api.example.com
 
         {
-          "name": "example"
+          "name": "example",
+          "private": false,
+          "deleted_at": null
         }
         ```
 
@@ -120,7 +136,9 @@ describe Jdoc::Generator do
 
         {
           "id": "01234567-89ab-cdef-0123-456789abcdef",
-          "name": "example"
+          "name": "example",
+          "private": false,
+          "deleted_at": null
         }
         ```
 
@@ -139,7 +157,9 @@ describe Jdoc::Generator do
 
         {
           "id": "01234567-89ab-cdef-0123-456789abcdef",
-          "name": "example"
+          "name": "example",
+          "private": false,
+          "deleted_at": null
         }
         ```
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jdoc
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-10 00:00:00.000000000 Z
+date: 2014-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis