From 0be349f306aaa988965fa68560e979ee2078a12e Mon Sep 17 00:00:00 2001
From: Rick Mouritzen <129233333+rmouritzen-splunk@users.noreply.github.com>
Date: Wed, 23 Oct 2024 19:44:28 -0700
Subject: [PATCH] Add support for new metadata attributes: source and
 references (#34)

* Add support for new metadata attributes: source and refeerences

* Bump version
---
 ocsf_validator/types.py | 12 ++++++++++++
 pyproject.toml          |  4 ++--
 2 files changed, 14 insertions(+), 2 deletions(-)

diff --git a/ocsf_validator/types.py b/ocsf_validator/types.py
index 6b75132..331c16d 100644
--- a/ocsf_validator/types.py
+++ b/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],
     },
 )
 
diff --git a/pyproject.toml b/pyproject.toml
index 0bcb84b..5cec732 100644
--- a/pyproject.toml
+++ b/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 <jeremy@query.ai>",
@@ -26,4 +26,4 @@ requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
 
 [tool.isort]
-profile = "black"
\ No newline at end of file
+profile = "black"