Add support for new metadata attributes: source and references (#34)

* Add support for new metadata attributes: source and refeerences

* Bump version

Author: rmouritzen-splunk

ocsf_validator/types.py

@@ -39,6 +39,14 @@ class OcsfDeprecationInfo(TypedDict):
     since: Required[str]
 
 
+class OcsfReference(TypedDict):
+    url: Required[str]
+    description: Required[str]
+
+
+OcsfReferences = Sequence[OcsfReference]
+
+
 OcsfAttr = TypedDict(
     "OcsfAttr",
     {
@@ -64,6 +72,8 @@ class OcsfDeprecationInfo(TypedDict):
         "profile": NotRequired[Optional[Sequence[str]]],
         "values": NotRequired[Sequence[Any]],
         "@deprecated": NotRequired[OcsfDeprecationInfo],
+        "source": NotRequired[str],
+        "references": NotRequired[OcsfReferences],
     },
 )
 
@@ -135,6 +145,7 @@ class OcsfProfile(TypedDict):
         "observables": NotRequired[Dict[str, int]],
         "$include": NotRequired[Union[str, Sequence[str]]],
         "@deprecated": NotRequired[OcsfDeprecationInfo],
+        "references": NotRequired[OcsfReferences],
     },
 )
 
@@ -155,6 +166,7 @@ class OcsfProfile(TypedDict):
         "observables": NotRequired[Dict[str, int]],
         "$include": NotRequired[Union[str, Sequence[str]]],
         "@deprecated": NotRequired[OcsfDeprecationInfo],
+        "references": NotRequired[OcsfReferences],
     },
 )
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ocsf-validator"
-version = "0.2.1"
+version = "0.2.2"
 description = "OCSF Schema Validation"
 authors = [
     "Jeremy Fisher <[email protected]>",
@@ -26,4 +26,4 @@ requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
 
 [tool.isort]
-profile = "black"
+profile = "black"