From cdc13226be8bfb9e112e4fc3612f64d23869ddfd Mon Sep 17 00:00:00 2001 From: lboeman Date: Tue, 13 Apr 2021 12:34:12 -0700 Subject: [PATCH] update top-level system descriptions --- api/solarperformanceinsight_api/models.py | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/api/solarperformanceinsight_api/models.py b/api/solarperformanceinsight_api/models.py index 07e29e01..7cfb0d31 100644 --- a/api/solarperformanceinsight_api/models.py +++ b/api/solarperformanceinsight_api/models.py @@ -709,16 +709,31 @@ class PVSystem(SPIBase): name: str = UserString( ..., + title="PV System Name", description="Name of the system", ) latitude: float = Field( - ..., description="Latitude of the system in degrees North", ge=-90, le=90 + ..., + description=( + "Latitude of the system in degrees NORTH of the equator. Use a NEGATIVE sign " + "for all systems in the southern hemisphere." + ), + ge=-90, + le=90, ) longitude: float = Field( - ..., description="Longitude of the system in degrees East", ge=-180, le=180 + ..., + description="Longitude of the system in degrees EAST of the prime meridian (zero degrees).", + ge=-180, + le=180, ) elevation: float = Field( - ..., description="Elevation of the system above sea level in meters", ge=-300 + ..., + description=( + "Elevation of the system in METERS above sea level. Use a NEGATIVE sign if the system " + "is below sea level." + ), + ge=-300, ) inverters: List[Inverter] = Field( ..., description="List of inverters that make up this system", min_items=1