Add nested json schema example

vdespa · Dec 28, 2019 · 73c462f · 73c462f
1 parent abe53da
commit 73c462f
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 3 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -26,7 +26,7 @@
 # The short X.Y version
 version = u''
 # The full version, including alpha/beta/rc tags
-release = u'Version 1.5.0 - December 2019'
+release = u'Version 1.5.1 - December 2019'
 
 
 # -- General configuration ---------------------------------------------------

diff --git a/docs/schema-validation.rst b/docs/schema-validation.rst
@@ -53,18 +53,47 @@ Possible types are:
 Object has required property
 ----------------------------
 
-This is the JSON response: ::
+Given this JSON response: ::
 
     {
         "code": "FX002"
     }
 
-This is the JSON schema with a property named code of type String that is mandatory: ::
+This is the JSON schema with a property named "code" of type String that is mandatory: ::
 
     const schema = {
         "type": "object",
         "properties": {
             "code": { "type": "string" }
         },
         "required": ["code"]
+    };
+
+Nested objects
+--------------
+
+Given this JSON response: ::
+
+    {
+        "code": "2",
+        "error": {
+            "message": "Not permitted."
+        }
+    }
+
+This is the JSON schema with the an nested object named "error" that has a property named "message" that is a string. ::
+
+    const schema = {
+        "type": "object",
+        "properties": {
+            "code": { "type": "string" },
+            "error": { 
+                "type": "object",
+                "properties": {
+                    "message": { type: "string" }
+                },
+                "required": ["message"]
+            }
+        },
+        "required": ["code", "error"]
     };