add project description

Author: clevinson

project/jsonschema/oae_data_protocol.schema.json

@@ -3087,6 +3087,11 @@
                     "title": "Co-located Operations",
                     "type": "string"
                 },
+                "description": {
+                    "description": "A narrative description of the project. For example, what were the goals of the project? What were the research questions? What were the processes to achieve these goals and answer these questions? Who were the key stakeholders, organizers, project leaders? Was this building off a previous or ongoing project, or is this a new region/experiment/mechanistic study?\nIf there are relevant regulatory parameters and/or limits to dosing trials at this location, these may be described here.",
+                    "title": "Project Description",
+                    "type": "string"
+                },
                 "experiments": {
                     "items": {
                         "$ref": "#/$defs/Experiment"

src/oae_data_protocol/datamodel/oae_data_protocol.py

@@ -1,5 +1,5 @@
 # Auto generated from oae_data_protocol.yaml by pythongen.py version: 0.0.1
-# Generation date: 2026-01-27T19:47:22
+# Generation date: 2026-01-27T20:07:46
 # Schema: OAEDataManagementProtocol
 #
 # id: OAEDataManagementProtocol
@@ -315,6 +315,7 @@ class Project(YAMLRoot):
     temporal_coverage: str = None
     spatial_coverage: Union[dict, SpatialCoverage] = None
     mcdr_pathway: Union[str, "MCDRPathway"] = None
+    description: Optional[str] = None
     experiments: Optional[Union[Union[dict, "Experiment"], List[Union[dict, "Experiment"]]]] = empty_list()
     sea_names: Optional[Union[Union[str, "SeaNames"], List[Union[str, "SeaNames"]]]] = empty_list()
     physical_site_description: Optional[str] = None
@@ -326,7 +327,6 @@ class Project(YAMLRoot):
     research_project: Optional[str] = None
     funding: Optional[Union[Union[dict, "MonetaryGrant"], List[Union[dict, "MonetaryGrant"]]]] = empty_list()
     additional_details: Optional[str] = None
-    description: Optional[str] = None
 
     def __post_init__(self, *_: List[str], **kwargs: Dict[str, Any]):
         if self._is_empty(self.project_id):
@@ -349,6 +349,9 @@ def __post_init__(self, *_: List[str], **kwargs: Dict[str, Any]):
         if not isinstance(self.mcdr_pathway, MCDRPathway):
             self.mcdr_pathway = MCDRPathway(self.mcdr_pathway)
 
+        if self.description is not None and not isinstance(self.description, str):
+            self.description = str(self.description)
+
         self._normalize_inlined_as_dict(slot_name="experiments", slot_type=Experiment, key_name="description", keyed=False)
 
         if not isinstance(self.sea_names, list):
@@ -382,9 +385,6 @@ def __post_init__(self, *_: List[str], **kwargs: Dict[str, Any]):
         if self.additional_details is not None and not isinstance(self.additional_details, str):
             self.additional_details = str(self.additional_details)
 
-        if self.description is not None and not isinstance(self.description, str):
-            self.description = str(self.description)
-
         super().__post_init__(**kwargs)
 
 

src/oae_data_protocol/schema/oae_project.yaml

@@ -12,6 +12,7 @@ classes:
     description: "A project conducting OAE field trials or modeling."
     slots:
       - project_id
+      - description
       - temporal_coverage
       - spatial_coverage
     slot_usage: