external links (#559)

* external links

* Code Ocean tweak

Author: mekhlakapoor

src/aind_data_schema/metadata.py

@@ -2,6 +2,7 @@
 
 from datetime import datetime
 from enum import Enum
+from typing import Dict, List
 
 from pydantic import Extra, Field
 
@@ -18,6 +19,12 @@ class MetadataStatus(Enum):
     UNKNOWN = "Unknown"
 
 
+class ExternalPlatforms(Enum):
+    """External Platforms of Data Assets."""
+
+    CODEOCEAN = "Code Ocean"
+
+
 class Metadata(AindCoreModel):
     """The records in the Data Asset Collection needs to contain certain fields
     to easily query and index the data."""
@@ -48,6 +55,9 @@ class Metadata(AindCoreModel):
     )
     metadata_status: MetadataStatus = Field(..., title=" Metadata Status", description="The status of the metadata.")
     schema_version: str = Field("0.0.1", title="Schema Version", const=True)
+    external_links: List[Dict[ExternalPlatforms, str]] = Field(
+        ..., title="External Links", description="Links to the data asset on different platforms."
+    )
     subject: Subject = Field(
         ...,
         title="Subject",

tests/test_metadata.py

@@ -3,7 +3,7 @@
 import unittest
 from datetime import datetime
 
-from aind_data_schema.metadata import Metadata, MetadataStatus
+from aind_data_schema.metadata import ExternalPlatforms, Metadata, MetadataStatus
 from aind_data_schema.procedures import Procedures
 from aind_data_schema.subject import Subject
 
@@ -22,6 +22,7 @@ def test_constructors(self):
             location="Test Location",
             metadata_status=MetadataStatus.VALID,
             subject=Subject.construct(),
+            external_links=[{ExternalPlatforms.CODEOCEAN: "abc-1234"}],
         )
         self.assertIsNotNone(d1)
         self.assertEqual(d1.schema_version, "0.0.1")
@@ -36,9 +37,11 @@ def test_constructors(self):
             metadata_status=MetadataStatus.VALID,
             subject=Subject.construct(),
             procedures=Procedures.construct(),
+            external_links=[{ExternalPlatforms.CODEOCEAN: "abc-1234"}],
         )
         self.assertIsNotNone(d2)
         self.assertTrue(hasattr(d2, "procedures"))
+        self.assertTrue(hasattr(d2, "external_links"))
 
 
 if __name__ == "__main__":