API: Change media type of GeoJSON response

The media type for GeoJSON text is "application/geo+json".
GIScience · Oct 25, 2021 · c8c75df · c8c75df
1 parent 4daf470
commit c8c75df
Show file tree

Hide file tree

Showing 6 changed files with 25 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,14 @@
 # Changelog
 
+## Current Main
+
+### Other Changes
+
+- API: Change media type of GeoJSON response ([#199])
+
+[#199]: https://github.com/GIScience/ohsome-quality-analyst/pull/199
+
+
 ## 0.6.0
 
 ### Breaking Changes

diff --git a/workers/ohsome_quality_analyst/api/api.py b/workers/ohsome_quality_analyst/api/api.py
@@ -3,7 +3,9 @@
 
 import pydantic
 from fastapi import FastAPI
+from fastapi.encoders import jsonable_encoder
 from fastapi.middleware.cors import CORSMiddleware
+from fastapi.responses import JSONResponse
 
 from ohsome_quality_analyst import (
     __author__,
@@ -140,7 +142,9 @@ async def _fetch_indicator(
     )
     response = empty_api_response()
     response.update(geojson_object)
-    return response
+    return JSONResponse(
+        content=jsonable_encoder(response), media_type="application/geo+json"
+    )
 
 
 @app.get("/report/{name}")
@@ -205,7 +209,9 @@ async def _fetch_report(name: str, parameters: ReportRequestModel):
     )
     response = empty_api_response()
     response.update(geojson_object)
-    return response
+    return JSONResponse(
+        content=jsonable_encoder(response), media_type="application/geo+json"
+    )
 
 
 @app.get("/regions")
@@ -219,9 +225,12 @@ async def get_available_regions(asGeoJSON: bool = False):
     if asGeoJSON is True:
         regions = await db_client.get_regions_as_geojson()
         response.update(regions)
+        return JSONResponse(
+            content=jsonable_encoder(response), media_type="application/geo+json"
+        )
     else:
         response["result"] = await db_client.get_regions()
-    return response
+        return response
 
 
 @app.get("/indicatorLayerCombinations")

diff --git a/workers/tests/integrationtests/test_api_indicator.py b/workers/tests/integrationtests/test_api_indicator.py
@@ -31,6 +31,7 @@ def setUp(self):
 
     def run_tests(self, response) -> None:
         self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.headers["content-type"], "application/geo+json")
         for schema in (self.general_schema, self.feature_schema):
             self.validate(response.json(), schema)
 

diff --git a/workers/tests/integrationtests/test_api_indicator_geojson_io.py b/workers/tests/integrationtests/test_api_indicator_geojson_io.py
@@ -39,6 +39,7 @@ def setUp(self):
 
     def run_tests(self, response, schemata: Tuple[Schema]) -> None:
         self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.headers["content-type"], "application/geo+json")
         for schema in schemata:
             self.validate(response.json(), schema)
 

diff --git a/workers/tests/integrationtests/test_api_report.py b/workers/tests/integrationtests/test_api_report.py
@@ -35,6 +35,7 @@ def setUp(self):
 
     def run_tests(self, response) -> None:
         self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.headers["content-type"], "application/geo+json")
         response_content = geojson.loads(response.content)
         self.assertTrue(response_content.is_valid)  # Valid GeoJSON?
         self.assertTrue(self.general_schema.is_valid(response_content))

diff --git a/workers/tests/integrationtests/test_api_report_geojson_io.py b/workers/tests/integrationtests/test_api_report_geojson_io.py
@@ -46,6 +46,7 @@ def setUp(self):
 
     def run_tests(self, response) -> None:
         self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.headers["content-type"], "application/geo+json")
 
         response_content = geojson.loads(response.content)
         self.assertTrue(response_content.is_valid)  # Valid GeoJSON?