API Fields descriptions

DHI · Dec 22, 2023 · aaf852b · aaf852b
1 parent 19400bc
commit aaf852b
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 9 deletions.
diff --git a/terracotta/server/rgb.py b/terracotta/server/rgb.py
@@ -35,9 +35,11 @@ class Meta:
         example="[0,1]",
         missing=None,
         description=(
-            "Stretch range [min, max] to use for red band as JSON array. Min and max may be "
-            "numbers to use as absolute range, or strings of the format p<int> "
-            "with an integer between 0 and 100 to use percentiles of the image instead."
+            "Stretch range [min, max] to use for the red band as JSON array. "
+            "Min and max may be numbers to use as absolute range, or strings "
+            "of the format p<int> with an integer between 0 and 100 to use "
+            "percentiles of the image instead. "
+            "Null values indicate global minimum / maximum."
         ),
     )
     g_range = fields.List(
@@ -46,8 +48,11 @@ class Meta:
         example="[0,1]",
         missing=None,
         description=(
-            "Stretch range [min, max] to use for red band as JSON array, "
-            "prefix with `p` for percentile"
+            "Stretch range [min, max] to use for the gren band as JSON array. "
+            "Min and max may be numbers to use as absolute range, or strings "
+            "of the format p<int> with an integer between 0 and 100 to use "
+            "percentiles of the image instead. "
+            "Null values indicate global minimum / maximum."
         ),
     )
     b_range = fields.List(
@@ -56,8 +61,11 @@ class Meta:
         example="[0,1]",
         missing=None,
         description=(
-            "Stretch range [min, max] to use for red band as JSON array, "
-            "prefix with `p` for percentile"
+            "Stretch range [min, max] to use for the blue band as JSON array. "
+            "Min and max may be numbers to use as absolute range, or strings "
+            "of the format p<int> with an integer between 0 and 100 to use "
+            "percentiles of the image instead. "
+            "Null values indicate global minimum / maximum."
         ),
     )
     tile_size = fields.List(

diff --git a/terracotta/server/singleband.py b/terracotta/server/singleband.py
@@ -39,8 +39,13 @@ class Meta:
         StringOrNumber(allow_none=True, validate=validate_stretch_range),
         validate=validate.Length(equal=2),
         example="[0,1]",
-        description="Stretch range to use as JSON array, uses full range by default. "
-        "Null values indicate global minimum / maximum.",
+        description=(
+            "Stretch range [min, max] to use for the band as JSON array. "
+            "Min and max may be numbers to use as absolute range, or strings "
+            "of the format p<int> with an integer between 0 and 100 to use "
+            "percentiles of the image instead. "
+            "Null values indicate global minimum / maximum."
+        ),
         missing=None,
     )