Made stream_resource::run_start optional and fixed incorrect description

bluesky · Oct 5, 2023 · 8a23344 · 8a23344
1 parent 6d3d8f2
commit 8a23344
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 10 deletions.
diff --git a/event_model/documents/stream_datum.py b/event_model/documents/stream_datum.py
@@ -36,8 +36,8 @@ class StreamDatum(TypedDict):
     uid: Annotated[
         str,
         Field(
-            description="A slice object passed to the StreamResource "
-            "handler so it can hand back data and timestamps."
+            description="Globally unique identifier for this Datum. A suggested "
+            "formatting being '<stream_resource>/<stream_name>/<block_id>"
         ),
     ]
     seq_nums: Annotated[

diff --git a/event_model/documents/stream_resource.py b/event_model/documents/stream_resource.py
@@ -43,12 +43,14 @@ class StreamResource(TypedDict):
             description="Subset of resource_path that is a local detail, not semantic."
         ),
     ]
-    run_start: Annotated[
-        str,
-        Field(
-            description="Globally unique ID to the run_start document "
-            "this Stream Resource is associated with.",
-        ),
+    run_start: NotRequired[
+        Annotated[
+            str,
+            Field(
+                description="Globally unique ID to the run_start document "
+                "this Stream Resource is associated with.",
+            ),
+        ]
     ]
     spec: Annotated[
         str,

diff --git a/event_model/schemas/stream_datum.json b/event_model/schemas/stream_datum.json
@@ -56,7 +56,7 @@
       },
       "uid": {
          "title": "Uid",
-         "description": "A slice object passed to the StreamResource handler so it can hand back data and timestamps.",
+         "description": "Globally unique identifier for this Datum. A suggested formatting being '<stream_resource>/<stream_name>/<block_id>",
          "type": "string"
       }
    },

diff --git a/event_model/schemas/stream_resource.json b/event_model/schemas/stream_resource.json
@@ -53,7 +53,6 @@
       "resource_kwargs",
       "resource_path",
       "root",
-      "run_start",
       "spec",
       "uid"
    ],