added enum choices to DataKey

Also made each field in `LimitsRange` optional.
bluesky · Sep 23, 2024 · 49a4ab1 · 49a4ab1
1 parent 72e40cd
commit 49a4ab1
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 5 deletions.
diff --git a/event_model/documents/event_descriptor.py b/event_model/documents/event_descriptor.py
@@ -1,4 +1,4 @@
-from typing import Any, Dict, List
+from typing import Any, Dict, List, Optional
 
 from typing_extensions import Annotated, Literal, NotRequired, TypedDict
 
@@ -8,8 +8,8 @@
 
 
 class LimitsRange(TypedDict):
-    low: float
-    high: float
+    low: Optional[float]
+    high: Optional[float]
 
 
 class Limits(TypedDict):
@@ -28,6 +28,9 @@ class DataKey(TypedDict):
     """Describes the objects in the data property of Event documents"""
 
     limits: NotRequired[Annotated[Limits, Field(description="Epics limits.")]]
+    choices: NotRequired[
+        Annotated[List[str], Field(description="Choices of enum value.")]
+    ]
     dims: NotRequired[
         Annotated[
             List[str],

diff --git a/event_model/schemas/event_descriptor.json b/event_model/schemas/event_descriptor.json
@@ -32,6 +32,14 @@
             "description": "Describes the objects in the data property of Event documents",
             "type": "object",
             "properties": {
+                "choices": {
+                    "title": "Choices",
+                    "description": "Choices of enum value.",
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                },
                 "dims": {
                     "title": "Dims",
                     "description": "The names for dimensions of the data. Null or empty list if scalar data",
@@ -126,11 +134,25 @@
             "properties": {
                 "high": {
                     "title": "High",
-                    "type": "number"
+                    "anyOf": [
+                        {
+                            "type": "number"
+                        },
+                        {
+                            "type": "null"
+                        }
+                    ]
                 },
                 "low": {
                     "title": "Low",
-                    "type": "number"
+                    "anyOf": [
+                        {
+                            "type": "number"
+                        },
+                        {
+                            "type": "null"
+                        }
+                    ]
                 }
             },
             "required": [