Support change to enum value definitions (#35)

ocsf · Dec 11, 2024 · 3e2286c · 3e2286c
1 parent 0be349f
commit 3e2286c
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 11 deletions.
diff --git a/ocsf_validator/types.py b/ocsf_validator/types.py
@@ -24,16 +24,6 @@ class OcsfVersion(TypedDict):
     version: str
 
 
-class OcsfEnumMember(TypedDict):
-    caption: str
-    description: NotRequired[str]
-    notes: NotRequired[str]
-
-
-class OcsfEnum(TypedDict):
-    enum: Dict[str, OcsfEnumMember]
-
-
 class OcsfDeprecationInfo(TypedDict):
     message: Required[str]
     since: Required[str]
@@ -47,6 +37,22 @@ class OcsfReference(TypedDict):
 OcsfReferences = Sequence[OcsfReference]
 
 
+OcsfEnumMember = TypedDict(
+    "OcsfEnumMember",
+    {
+        "@deprecated": NotRequired[OcsfDeprecationInfo],
+        "caption": str,
+        "description": NotRequired[str],
+        "source": NotRequired[str],
+        "references": NotRequired[OcsfReferences],
+    },
+)
+
+
+class OcsfEnum(TypedDict):
+    enum: Dict[str, OcsfEnumMember]
+
+
 OcsfAttr = TypedDict(
     "OcsfAttr",
     {

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ocsf-validator"
-version = "0.2.2"
+version = "0.2.3"
 description = "OCSF Schema Validation"
 authors = [
     "Jeremy Fisher <[email protected]>",