Merge pull request #312 from burkeds/hint_NX_class

ENH: Added NX_class as a PerObjectHint to the event descriptor.
bluesky · Aug 23, 2024 · a2f134c · a2f134c
2 parents 1451187 + 6ae878b
commit a2f134c
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/event_model/documents/event_descriptor.py b/event_model/documents/event_descriptor.py
@@ -69,6 +69,15 @@ class PerObjectHint(TypedDict):
             Field(description="The 'interesting' data keys for this device."),
         ]
     ]
+    NX_class: NotRequired[
+        Annotated[
+            str,
+            Field(
+                description="The NeXus class definition for this device.",
+                pattern=r"^NX[A-Za-z_]+$",
+            ),
+        ]
+    ]
 
 
 class Configuration(TypedDict):

diff --git a/event_model/schemas/event_descriptor.json b/event_model/schemas/event_descriptor.json
@@ -112,6 +112,12 @@
             "description": "The 'interesting' data keys for this device.",
             "type": "object",
             "properties": {
+                "NX_class": {
+                    "title": "Nx Class",
+                    "description": "The NeXus class definition for this device.",
+                    "type": "string",
+                    "pattern": "^NX[A-Za-z_]+$"
+                },
                 "fields": {
                     "title": "Fields",
                     "description": "The 'interesting' data keys for this device.",