Merge pull request #97 from Alexander-D-Lewis/feature/update-sdk-schema

update sdk schema with description, is_latest_version and update_beha…

docs/changelog/sdk.md

@@ -1,5 +1,11 @@
 # SDK Changelog
 
+## v0.1.9 - _2024-09-12_
+
+### Features
+
+- Expanded rAPId sdk metadata to include: update_behaviour, is_latest_version and description.
+
 ## v0.1.8 - _2024-03-21_
 
 ### Features

sdk/rapid/items/schema.py

@@ -28,6 +28,9 @@ class SchemaMetadata(BaseModel):
     version: Optional[int] = None
     key_value_tags: Optional[Dict[str, str]] = {}
     key_only_tags: Optional[List[str]] = []
+    description: Optional[str] = ""
+    update_behaviour: Optional[str] = "APPEND"
+    is_latest_version: Optional[bool] = True
 
     class Config:
         use_enum_values = True

sdk/setup.py

@@ -2,7 +2,7 @@
 import os
 
 TEST_SDK_VERSION = os.getenv("TEST_SDK_VERSION")
-version = "0.1.8"
+version = "0.1.9"
 setup(
     name="rapid-sdk",
     version=version if TEST_SDK_VERSION is None else f"{version}.{TEST_SDK_VERSION}",

sdk/tests/test_items/test_schema.py

@@ -38,6 +38,9 @@
     dataset="rapid_sdk",
     sensitivity=SensitivityLevel.PUBLIC,
     owners=[Owner(name="Test", email="[email protected]")],
+    description="test",
+    update_behaviour="OVERWRITE",
+    is_latest_version=True,
 )
 
 
@@ -62,13 +65,19 @@ def test_create_schema_metadata_from_dict(self):
             "dataset": "rapid_sdk",
             "sensitivity": SensitivityLevel.PUBLIC,
             "owners": [{"name": "Test", "email": "[email protected]"}],
+            "description": "test",
+            "update_behaviour": "OVERWRITE",
+            "is_latest_version": True,
         }
 
         schema_metadata = SchemaMetadata(**_schema_metadata)
         assert schema_metadata.domain == "test"
         assert schema_metadata.dataset == "rapid_sdk"
         assert schema_metadata.sensitivity == "PUBLIC"
         assert schema_metadata.owners == [Owner(name="Test", email="[email protected]")]
+        assert schema_metadata.description == "test"
+        assert schema_metadata.update_behaviour == "OVERWRITE"
+        assert schema_metadata.is_latest_version == True
 
 
 class TestColumn:
@@ -265,6 +274,9 @@ def test_schema_returns_correct_dictionary(self):
                 "version": None,
                 "key_value_tags": {},
                 "key_only_tags": [],
+                "description": "test",
+                "update_behaviour": "OVERWRITE",
+                "is_latest_version": True,
             },
             "columns": [
                 {