Merge pull request #1321 from Open-EO/colormap-info

Better document colormap parameter

Author: EmileSonneveld

openeogeotrellis/backend.py

@@ -431,6 +431,17 @@ def oidc_providers(self) -> List[OidcProvider]:
         return get_backend_config().oidc_providers
 
     def file_formats(self) -> dict:
+        colormap_properties = {
+            "anyOf": [
+                {"type": "integer"},
+                {
+                    "type": "array",
+                    "items": {"type": "number", "minimum": 0, "maximum": 1},
+                    "minItems": 4,
+                    "maxItems": 4,
+                },
+            ]
+        }
         return {
             "input": {
                 "GeoJSON": {
@@ -462,6 +473,7 @@ def file_formats(self) -> dict:
                 "GTiff": {
                     "title": "GeoTiff",
                     "description": "Cloud Optimized Geotiff is one of the most widely supported formats and thus a popular choice for further dissemination. This implementation stores all bands in one file, and creates one file per timestamp in your datacube.",
+                    "type": "object",
                     "gis_data_types": ["raster"],
                     "parameters": {
                         "tile_grid": {
@@ -494,7 +506,8 @@ def file_formats(self) -> dict:
                         "colormap": {
                             "type": ["object", "null"],
                             "description": "Allows specifying a colormap, for single band geotiffs. The colormap is a dictionary mapping band values to colors, specified by an integer.",
-                            "default": None
+                            "default": None,
+                            "additionalProperties": colormap_properties,
                         },
                         "filename_prefix": {
                             "type": "string",
@@ -540,7 +553,8 @@ def file_formats(self) -> dict:
                         "colormap": {
                             "type": ["object", "null"],
                             "description": "Allows specifying a colormap, for single band PNGs. The colormap is a dictionary mapping band values to colors, either specified by an integer or an array of [R, G, B, A], where each value lies between 0.0 and 1.0.",
-                            "default": None
+                            "default": None,
+                            "additionalProperties": colormap_properties,
                         },
                     }
                 },

setup.py

@@ -32,6 +32,7 @@
     "rio_cogeo",
     "pydantic~=1.0",
     "zarr",
+    "jsonschema",
 ]
 
 typing_require = [

tests/test_views.py

@@ -12,6 +12,7 @@
 from unittest import mock
 
 import boto3
+import jsonschema
 import kazoo.exceptions
 import pytest
 import requests
@@ -50,6 +51,13 @@ def test_capabilities(self, api100):
 
     def test_file_formats(self, api100):
         formats = api100.get("/file_formats").assert_status_code(200).json
+        formats_schema = {
+            "$schema": "http://json-schema.org/draft-07/schema#",
+            "$id": "https://processes.openeo.org/2.0.0-rc.1/meta/subtype-schemas.json",
+            "type": "object",
+            "properties": formats["output"],
+        }
+        jsonschema.validate(instance=formats_schema, schema={"$ref": "http://json-schema.org/draft-07/schema#"})
         assert "GeoJSON" in formats["input"]
         assert "GTiff" in formats["output"]
         assert "CovJSON" in formats["output"]