Merge pull request #89 from stuartcampbell/detector-granularity

Add detector directory granularity

src/nsls2api/api/models/proposal_model.py

@@ -4,7 +4,7 @@
 import pydantic
 
 from nsls2api.models.proposals import Proposal, User
-from nsls2api.api.models.beamline_model import AssetDirectoryGranularity
+from nsls2api.models.beamlines import AssetDirectoryGranularity
 
 
 class UsernamesList(pydantic.BaseModel):
@@ -69,7 +69,7 @@ class ProposalDirectories(pydantic.BaseModel):
     cycle: str | None = None
     users: list[dict[str, str]]
     groups: list[dict[str, str]]
-    directory_most_granular_level: AssetDirectoryGranularity | None = None
+    directory_most_granular_level: AssetDirectoryGranularity | None = AssetDirectoryGranularity.day
 
     model_config = {
         "json_schema_extra": {

src/nsls2api/models/beamlines.py

@@ -4,10 +4,29 @@
 import beanie
 import pydantic
 
+from enum import StrEnum
+
+
+class AssetDirectoryGranularity(StrEnum):
+    """
+    Represents the granularity options for asset directory YYYY/MM/DD/HH tree structure.
+    The value specifies the most granular level to create directories for.  If no date
+    structure is wanted then the value "flat" is used.
+    """
+
+    flat = "flat"
+    year = "year"
+    month = "month"
+    day = "day"
+    hour = "hour"
+
 
 class Detector(pydantic.BaseModel):
     name: str
-    directory_name: str | None = None
+    directory_name: str
+    granularity: AssetDirectoryGranularity | None = AssetDirectoryGranularity.day
+    description: str | None = None
+    manufacturer: str | None = None
 
 
 class DetectorView(pydantic.BaseModel):

src/nsls2api/services/beamline_service.py

@@ -5,7 +5,7 @@
 from beanie.odm.operators.find.comparison import In
 from beanie.odm.operators.find.array import ElemMatch
 
-from nsls2api.api.models.beamline_model import AssetDirectoryGranularity
+from nsls2api.models.beamlines import AssetDirectoryGranularity
 from nsls2api.infrastructure.logging import logger
 from nsls2api.models.beamlines import (
     Beamline,
@@ -146,7 +146,7 @@ async def operator_username(name: str) -> str:
 
     if operator_account is None:
         raise LookupError(
-            f"Could not find a the operattor account for the {name} beamline."
+            f"Could not find a the operator account for the {name} beamline."
         )
 
     return operator_account.username
@@ -228,6 +228,7 @@ async def proposal_directory_skeleton(name: str):
         "users": users_acl,
         "groups": groups_acl,
         "beamline": name.upper(),
+        "directory_most_granular_level": AssetDirectoryGranularity.flat,
     }
     directory_list.append(asset_directory)
 
@@ -241,7 +242,7 @@ async def proposal_directory_skeleton(name: str):
                 "users": users_acl,
                 "groups": groups_acl,
                 "beamline": name.upper(),
-                "directory_most_granular_level": AssetDirectoryGranularity.day,
+                "directory_most_granular_level": detector.granularity,
             }
             directory_list.append(directory)