jdoc 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ecaf31b4e9cc6005cf7980e77b5f8967a9d1e4a1
-  data.tar.gz: 449ee41071bbf4467556d1150418f32bf686b530
+  metadata.gz: 9cba6d88f3a7501c3c240ed691dee7f1f68a3b73
+  data.tar.gz: 08d484a97ce19deac8f5a50f32dc5103e925144a
 SHA512:
-  metadata.gz: 6f1bc864b397b9c4bd30ff0a936a5856e2a965d47773a195a91c00267e807231872831b85f4cef362578fce891dfdd00b3bc82312a58c924cd5070fbfb8419cd
-  data.tar.gz: f1788851e9708e9ffc34eb8a8adafc3775f63c1eb789da355e0035a4ae33047e810c9932e22487b7fa073a4900d3e6f2e17f3571193556b7f11147b13c694ef6
+  metadata.gz: b78a21dc60b11f898b74aa700bf0cb0b90feebc8f9cbeeb2bc7604b16c2ff0fd2d08812d235bff86f5aa1869b02430fa16e7b5615d05f92a5389fb235304bc84
+  data.tar.gz: eae3dc35b17b5c6a1cf4836e4cb6eed22ca1f10a63735ace67d9cd055d42c7fd3c6758eeb25885e55bebf23bff94f9022a53c7d75f7044f213eb00d1bd2eb5ae

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.1.1
+* Support has-one relation
+
 ## 0.1.0
 * Show resources which have no links
 

data/lib/jdoc/link.rb

@@ -142,7 +142,7 @@ module Jdoc
           result.merge(
             key => case
             when !value.properties.empty?
-              call(value)
+              call(value.properties)
             when !value.data["example"].nil?
               value.data["example"]
             when value.type.include?("null")

data/lib/jdoc/version.rb

@@ -1,3 +1,3 @@
 module Jdoc
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/fixtures/schema.yml

@@ -86,6 +86,24 @@ definitions:
         type: array
         items:
           "$ref": "#/definitions/user"
+  recipe:
+    title: Recipe
+    type: object
+    definitions:
+      name:
+        type: string
+        example: "Sushi"
+    properties:
+      name:
+        "$ref": "#/definitions/recipe/definitions/name"
+      user:
+        "$ref": "#/definitions/user"
+    links:
+    - title: List
+      description: List recipes
+      method: GET
+      href: "/recipes"
+      rel: instances
   user:
     title: User
     type: object
@@ -99,6 +117,8 @@ definitions:
 properties:
   app:
     "$ref": "#/definitions/app"
+  recipe:
+    "$ref": "#/definitions/recipe"
   user:
     "$ref": "#/definitions/user"
 type:

data/spec/jdoc/generator_spec.rb

@@ -25,6 +25,8 @@ describe Jdoc::Generator do
          * [GET /apps/:id](#get-appsid)
          * [GET /apps](#get-apps)
          * [PATCH /apps/:id](#patch-appsid)
+        * [Recipe](#recipe)
+         * [GET /recipes](#get-recipes)
         * [User](#user)
 
         ## App
@@ -187,6 +189,37 @@ describe Jdoc::Generator do
         }
         ```
 
+        ## Recipe
+
+
+        ### Properties
+        * name - 
+         * Example: `"Sushi"`
+         * Type: string
+        * user - 
+         * Type: object
+
+        ### GET /recipes
+        List recipes
+
+        ```
+        GET /recipes HTTP/1.1
+        Content-Type: application/json
+        Host: api.example.com
+        ```
+
+        ```
+        HTTP/1.1 200
+        Content-Type: application/json
+
+        {
+          "name": "Sushi",
+          "user": {
+            "name": "alice"
+          }
+        }
+        ```
+
         ## User
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jdoc
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ryo Nakamura