Updated fields included in SensorThings properties.

Author: Ken Lippold

iam/models/workspace.py

@@ -47,6 +47,10 @@ class Workspace(models.Model):
 
     objects = WorkspaceQueryset.as_manager()
 
+    @property
+    def link(self):
+        return f"{settings.PROXY_BASE_URL}/api/auth/workspaces/{self.id}"
+
     @property
     def transfer_details(self):
         return getattr(self, "transfer_confirmation", None)

sta/schemas/sensorthings/datastream.py

@@ -4,6 +4,7 @@
 from typing import Optional, Literal
 from sensorthings.components.datastreams.schemas import (DatastreamGetResponse as DefaultDatastreamGetResponse,
                                                          DatastreamListResponse as DefaultDatastreamListResponse)
+from .workspace import WorkspaceProperties
 
 
 class DatastreamProperties(Schema):
@@ -18,6 +19,7 @@ class DatastreamProperties(Schema):
     aggregation_statistic: Optional[str] = None
     time_aggregation_interval: float
     time_aggregation_interval_unit_of_measurement: Literal["seconds", "minutes", "hours", "days"]
+    workspace: WorkspaceProperties
 
     model_config = ConfigDict(populate_by_name=True, str_strip_whitespace=True, alias_generator=to_camel)
 

sta/schemas/sensorthings/location.py

@@ -5,6 +5,7 @@
 from datetime import datetime
 from sensorthings.components.locations.schemas import (LocationGetResponse as DefaultLocationGetResponse,
                                                        LocationListResponse as DefaultLocationListResponse)
+from .workspace import WorkspaceProperties
 
 
 class LocationProperties(Schema):
@@ -13,6 +14,7 @@ class LocationProperties(Schema):
     elevation_m: Optional[float] = Field(None, alias="elevation_m")
     elevation_datum: Optional[str] = None
     last_updated: Optional[datetime] = None
+    workspace: WorkspaceProperties
 
     model_config = ConfigDict(populate_by_name=True, str_strip_whitespace=True, alias_generator=to_camel)
 

sta/schemas/sensorthings/observed_property.py

@@ -1,15 +1,18 @@
 from ninja import Schema
 from pydantic import ConfigDict
 from pydantic.alias_generators import to_camel
+from typing import Optional
 from sensorthings.components.observedproperties.schemas import (ObservedPropertyGetResponse as
                                                                 DefaultObservedPropertyGetResponse,
                                                                 ObservedPropertyListResponse as
                                                                 DefaultObservedPropertyListResponse)
+from .workspace import WorkspaceProperties
 
 
 class ObservedPropertyProperties(Schema):
     variable_code: str
     variable_type: str
+    workspace: Optional[WorkspaceProperties] = None
 
     model_config = ConfigDict(populate_by_name=True, str_strip_whitespace=True, alias_generator=to_camel)
 

sta/schemas/sensorthings/sensor.py

@@ -5,6 +5,7 @@
 from sensorthings.types import AnyHttpUrlString
 from sensorthings.components.sensors.schemas import (SensorGetResponse as DefaultSensorGetResponse,
                                                      SensorListResponse as DefaultSensorListResponse)
+from .workspace import WorkspaceProperties
 
 
 class SensorModel(Schema):
@@ -23,7 +24,7 @@ class SensorModel(Schema):
 ]
 
 
-class SensorProperties(Schema):
+class SensorMetadata(Schema):
     method_code: Optional[str] = None
     method_type: str
     method_link: Optional[AnyHttpUrlString] = None
@@ -32,9 +33,14 @@ class SensorProperties(Schema):
     model_config = ConfigDict(populate_by_name=True, str_strip_whitespace=True, alias_generator=to_camel)
 
 
+class SensorProperties(Schema):
+    workspace: Optional[WorkspaceProperties] = None
+
+
 class SensorGetResponse(DefaultSensorGetResponse):
     encoding_type: sensorEncodingTypes
-    sensor_metadata: SensorProperties = Field(..., alias="metadata")
+    sensor_metadata: SensorMetadata = Field(..., alias="metadata")
+    properties: SensorProperties
 
     model_config = ConfigDict(populate_by_name=True, str_strip_whitespace=True, alias_generator=to_camel)
 

sta/schemas/sensorthings/thing.py

@@ -1,14 +1,22 @@
 from ninja import Schema
 from pydantic import ConfigDict
 from pydantic.alias_generators import to_camel
+from typing import Optional
+from sensorthings.types import AnyHttpUrlString
 from sensorthings.components.things.schemas import (ThingGetResponse as DefaultThingGetResponse,
                                                     ThingListResponse as DefaultThingListResponse)
+from .workspace import WorkspaceProperties
 
 
 class ThingProperties(Schema):
     sampling_feature_type: str
     sampling_feature_code: str
     site_type: str
+    data_disclaimer: Optional[str] = None
+    is_private: bool
+    workspace: WorkspaceProperties
+    photos: list[AnyHttpUrlString]
+    tags: dict[str, str]
 
     model_config = ConfigDict(populate_by_name=True, str_strip_whitespace=True, alias_generator=to_camel)
 

sta/schemas/sensorthings/workspace.py

@@ -0,0 +1,14 @@
+from ninja import Schema
+from pydantic import ConfigDict
+from pydantic.alias_generators import to_camel
+from uuid import UUID
+from sensorthings.types import AnyHttpUrlString
+
+
+class WorkspaceProperties(Schema):
+    id: UUID
+    name: str
+    link: AnyHttpUrlString
+    is_private: bool
+
+    model_config = ConfigDict(populate_by_name=True, str_strip_whitespace=True, alias_generator=to_camel)

sta/services/sensorthings/datastream.py

@@ -122,6 +122,12 @@ def get_datastreams(
                     "aggregation_statistic": datastream.aggregation_statistic,
                     "time_aggregation_interval": datastream.time_aggregation_interval,
                     "time_aggregation_interval_unit_of_measurement": datastream.time_aggregation_interval_unit,
+                    "workspace": {
+                        "id": datastream.thing.workspace.id,
+                        "name": datastream.thing.workspace.name,
+                        "link": datastream.thing.workspace.link,
+                        "is_private": datastream.thing.workspace.is_private
+                    }
                 }
             } for datastream in datastreams
         }, count

sta/services/sensorthings/location.py

@@ -84,6 +84,12 @@ def get_locations(
                     "elevation_datum": location.elevation_datum,
                     "state": location.state,
                     "county": location.county,
+                    "workspace": {
+                        "id": location.thing.workspace.id,
+                        "name": location.thing.workspace.name,
+                        "link": location.thing.workspace.link,
+                        "is_private": location.thing.workspace.is_private
+                    }
                 },
                 "thing_ids": [location.thing_id]
             } for location in locations

sta/services/sensorthings/observed_property.py

@@ -65,6 +65,12 @@ def get_observed_properties(
                 "properties": {
                     "variable_code": observed_property.code,
                     "variable_type": observed_property.observed_property_type,
+                    "workspace": {
+                        "id": observed_property.workspace.id,
+                        "name": observed_property.workspace.name,
+                        "link": observed_property.workspace.link,
+                        "is_private": observed_property.workspace.is_private
+                    } if observed_property.workspace else None
                 }
             } for observed_property in observed_properties
         }, count