Adds example of URI type reference

dragonwasrobot · Aug 7, 2017 · bbbd5a2 · bbbd5a2
1 parent bed83c0
commit bbbd5a2
Showing 1 changed file with 25 additions and 5 deletions.
diff --git a/lib/types/type_reference.ex b/lib/types/type_reference.ex
@@ -5,22 +5,42 @@ defmodule JS2E.Types.TypeReference do
   JSON Schema:
 
       "self": {
-          "$ref": "#/definitions/link"
+        "$ref": "#/definitions/foo"
       }
 
-  Where "#/definitions/link" resolves to
+      "other": {
+        "$ref": "http://www.example.com/definitions.json#bar"
+      }
+
+  Where "#/definitions/foo" resolves to
 
       "definitions": {
-          "link": {
-              "type": "string"
-          }
+        "foo": {
+          "type": "string"
+        }
+      }
+
+  and "http://www.example.com/definitions.json#bar" resolves to
+
+      "definitions": {
+        "bar": {
+          "id": "#bar",
+          "type": "number"
+        }
       }
 
   Elixir intermediate representation:
 
       %TypeReference{name: "self",
                      path: ["#", "definitions", "link"]}
 
+      %TypeReference{name: "other",
+                     path: %URI{scheme: "http",
+                                host: "www.example.com",
+                                path: "/definitions.json",
+                                fragment: "bar",
+                                ...}}
+
   """
 
   alias JS2E.Types