Merge pull request #15 from tacaswell/enh_hints

Enh hints
bluesky · May 7, 2018 · 6fe4d8f · 6fe4d8f
2 parents 6ffef09 + 3814524
commit 6fe4d8f
Show file tree

Hide file tree

Showing 2 changed files with 57 additions and 0 deletions.
diff --git a/event_model/schemas/event_descriptor.json b/event_model/schemas/event_descriptor.json
@@ -21,6 +21,7 @@
                         "description": "Where the data is stored if it is stored external to the events."
                     },
                     "shape": {
+                        "type": "array",
                         "items": {
                             "type": "integer"
                         },
@@ -42,6 +43,24 @@
                 "title" : "data_type",
                 "patternProperties": {"^([^./]+)$": {"$ref": "#/definitions/data_type"}},
                 "additionalProperties": false
+            },
+            "object_hints": {
+                "title": "Object Hints",
+                "patternProperties": {"^([^./]+)$": {"$ref": "#/definitions/per_object_hint"}},
+                "additionalProperties": false
+            },
+            "per_object_hint": {
+                "type": "object",
+                "properties": {
+                    "fields":
+                    {
+                        "description": "The 'interesting' data keys for this device.",
+                        "type": "array",
+                        "items":{
+                            "type": "string"
+                        }
+                    }
+                }
             }
         },
         "properties": {
@@ -65,6 +84,9 @@
             "time": {
                 "type": "number",
                 "description": "Creation time of the document as unix epoch time."
+            },
+            "hints": {
+                "$ref": "#/definitions/object_hints"
             }
         },
         "patternProperties": {

diff --git a/event_model/schemas/run_start.json b/event_model/schemas/run_start.json
@@ -34,6 +34,41 @@
         "owner": {
             "type": "string",
             "description": "Unix owner to associate this data with"
+        },
+        "hints": {
+            "type": "object",
+            "description": "Start-level hints",
+            "properties": {
+                "dimensions": {
+                    "type": "array",
+                    "description": "The indepented axes of the experiment.  Ordered slow to fast",
+                    "items": {
+                        "type": "array",
+                        "description": "Each entry in this list is of the from ([<FIELD>, ...], <STREAM>).  A 1d scan will have 1 such entry, a scan with 3 independent entries would have 3",
+                        "items": [
+                            {
+                                "type": "array",
+                                "description": "The data key(s) for the given dimension.",
+                                "items":
+                                {
+                                    "type": "string"
+                                }
+                            },
+                            {
+                                "type": "string",
+                                "description": "The stream to find the datakeys in."
+
+                            }
+                        ],
+                        "additionalItems": false,
+                        "minItems": 2
+
+                    }
+                }
+            },
+            "patternProperties": {
+                "^([^.]+)$": {"$ref": "#/definitions/data_type"}},
+            "additionalProperties": false
         }
     },
     "patternProperties": {