Toolbox documentation

Author: SeanMcOwen

docs/Glossary/Toolbox.md

@@ -19,34 +19,33 @@ A toolbox consists of:
 
 The top level schema of a toolbox is:
 
-```json
-{
-  "ID": "string (required)",
-  "Name": "string (required)",
-  "Description": "string (optional)"
+```
+object {
+  Spaces: array[Space] (required)
+  Blocks: array[Block] (required)
 }
 ```
 
 And the children schemas are as follows below.
 
 ### Block Schema
 
-```json
-{
-  "ID": "string (required)",
-  "Name": "string (required)",
-  "Description": "string (optional)"
+```
+object {
+  ID: string (required)
+  Name: string (required)
+  Description: string
+  Domain: array[string] (required)
+  Codomain: array[string] (required)
 }
 ```
 
 ### Space Schema
 
-```json
-{
-  "ID": "string (required)",
-  "Name": "string (required)",
-  "Description": "string (optional)",
-  "Domain": "array[Space] (required, can be empty)",
-  "Codomain": "array[Space] (required, can be empty)"
+```
+object {
+  ID: string (required)
+  Name: string (required)
+  Description: string
 }
 ```

scratch/schema.ipynb

@@ -135,6 +135,27 @@
     "print(format_json_schema_draft07(schema2))\"\"\""
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "array[object {\n",
+      "  ID: string (required)\n",
+      "  Name: string (required)\n",
+      "  Description: string\n",
+      "}]\n"
+     ]
+    }
+   ],
+   "source": [
+    "print(format_json_schema_draft07(schema[\"properties\"][\"Toolbox\"][\"properties\"][\"Spaces\"]))"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 2,