Add buffer_paths and buffers keys to the v1 widgets schema.

Since these arguments are optional, this is backwards compatible, so should be schema version 1.1.
jasongrout · Apr 19, 2017 · c28ba08 · c28ba08
1 parent 907627d
commit c28ba08
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/jupyter-widgets-schema/v1/state.schema.json b/jupyter-widgets-schema/v1/state.schema.json
@@ -36,6 +36,25 @@
                         "description" : "Serialized state of the model",
                         "type": "object",
                         "additional_properties": true
+                    },
+                    "buffer_paths": {
+                        "description" : "List of paths in the state for the corresponding buffers",
+                        "type": "array",
+                        "items": {
+                            "description": "A path for a binary buffer value.",
+                            "type": "array",
+                            "items": {
+                                "description": "An object key or list index",
+                                "anyOf": [{"type": "string"}, {"type": "number"}]
+                            }
+                        }
+                    },
+                    "buffers": {
+                        "description" : "List of base64-encoded binary buffers",
+                        "type": "array",
+                        "items": {
+                            "type": "string"
+                        }
                     }
                 },
                 "required": [ "model_name", "model_module", "state" ],