add file formats and parse them into the api core

Author: SerRichard

openeo_fastapi/api/app.py

@@ -64,6 +64,21 @@ def register_get_conformance(self):
             endpoint=self.client.get_conformance,
         )
 
+    def register_get_file_formats(self):
+        """Register conformance page (GET /file_formats).
+        Returns:
+            None
+        """
+        self.router.add_api_route(
+            name="conformance",
+            path=f"/{self.client.settings.OPENEO_VERSION}/file_formats",
+            response_model=responses.FileFormatsGetResponse,
+            response_model_exclude_unset=False,
+            response_model_exclude_none=True,
+            methods=["GET"],
+            endpoint=self.client.get_file_formats,
+        )
+
     def register_get_collections(self):
         """Register collection Endpoint (GET /collections).
         Returns:
@@ -352,6 +367,7 @@ def register_core(self):
             None
         """
         self.register_get_conformance()
+        self.register_get_file_formats()
         self.register_get_collections()
         self.register_get_collection()
         self.register_get_processes()

openeo_fastapi/api/responses.py

@@ -1,13 +1,14 @@
 import uuid
 from enum import Enum
-from typing import Any, Optional, TypedDict, Union
+from typing import Any, Dict, List, Optional, TypedDict, Union
 
 from pydantic import AnyUrl, BaseModel, Extra, Field, validator
 
 from openeo_fastapi.api.types import (
     Billing,
     Endpoint,
     File,
+    FileFormat,
     Link,
     Process,
     RFC3339Datetime,
@@ -457,3 +458,16 @@ class JobsGetEstimateGetResponse(BaseModel):
 class FilesGetResponse(BaseModel):
     files: list[File]
     links: list[Link]
+
+
+class FileFormatsGetResponse(BaseModel):
+    input: dict[str, FileFormat] = Field(
+        ...,
+        description="Map of supported input file formats, i.e. file formats a back-end can **read** from. The property keys are the file format names that are used by clients and users, for example in process graphs.",
+        title="Input File Formats",
+    )
+    output: dict[str, FileFormat] = Field(
+        ...,
+        description="Map of supported output file formats, i.e. file formats a back-end can **write** to. The property keys are the file format names that are used by clients and users, for example in process graphs.",
+        title="Output File Formats",
+    )

openeo_fastapi/api/types.py

@@ -1,7 +1,7 @@
 import datetime
 from enum import Enum
 from pathlib import Path
-from typing import Any, List, Optional, Union
+from typing import Any, Dict, List, Optional, Union
 
 from pydantic import AnyUrl, BaseModel, Extra, Field, validator
 
@@ -57,6 +57,13 @@ class Level(Enum):
     debug = "debug"
 
 
+class GisDataType(Enum):
+    raster = "raster"
+    vector = "vector"
+    table = "table"
+    other = "other"
+
+
 class RFC3339Datetime(BaseModel):
     """Class to consistently represent datetimes as strings compliant to RFC3339Datetime."""
 
@@ -317,3 +324,23 @@ class Error(BaseModel):
         example="Parameter 'sample' is missing.",
     )
     links: Optional[list[Link]] = None
+
+
+class FileFormat(BaseModel):
+    title: str
+    description: Optional[str] = None
+    gis_data_types: list[GisDataType] = Field(
+        ...,
+        description="Specifies the supported GIS spatial data types for this format.\nIt is RECOMMENDED to specify at least one of the data types, which will likely become a requirement in a future API version.",
+    )
+    deprecated: Optional[bool] = None
+    experimental: Optional[bool] = None
+    parameters: dict[str, Any] = Field(
+        ...,
+        description="Specifies the supported parameters for this file format.",
+        title="File Format Parameters",
+    )
+    links: Optional[list[Link]] = Field(
+        None,
+        description="Links related to this file format, e.g. external documentation.\n\nFor relation types see the lists of\n[common relation types in openEO](#section/API-Principles/Web-Linking).",
+    )

openeo_fastapi/client/core.py

@@ -18,6 +18,8 @@ class OpenEOCore:
     """Base client for the OpenEO Api."""
 
     billing: str = field()
+    input_formats: list = field()
+    output_formats: list = field()
     links: list = field()
 
     settings = AppSettings()
@@ -97,3 +99,10 @@ def get_conformance(self) -> responses.ConformanceGetResponse:
         return responses.ConformanceGetResponse(
             conformsTo=conformance.BASIC_CONFORMANCE_CLASSES
         )
+
+    def get_file_formats(self) -> responses.FileFormatsGetResponse:
+        """ """
+        return responses.FileFormatsGetResponse(
+            input={_format.title: _format for _format in self.input_formats},
+            output={_format.title: _format for _format in self.output_formats},
+        )

tests/api/test_api.py

@@ -5,7 +5,15 @@
 
 from openeo_fastapi.api.app import OpenEOApi
 from openeo_fastapi.api.responses import FilesGetResponse
-from openeo_fastapi.api.types import Billing, Endpoint, File, Link, Plan
+from openeo_fastapi.api.types import (
+    Billing,
+    Endpoint,
+    File,
+    FileFormat,
+    GisDataType,
+    Link,
+    Plan,
+)
 from openeo_fastapi.client.auth import Authenticator, User
 from openeo_fastapi.client.core import OpenEOCore
 from openeo_fastapi.client.files import FILE_ENDPOINTS, FilesRegister
@@ -42,6 +50,18 @@ def test_get_conformance(core_api, app_settings):
     assert len(BASIC_CONFORMANCE_CLASSES) == len(response.json()["conformsTo"])
 
 
+def test_get_file_formats(core_api, app_settings):
+    """Test the /conformance endpoint as intended."""
+
+    from openeo_fastapi.client.conformance import BASIC_CONFORMANCE_CLASSES
+
+    test_app = TestClient(core_api.app)
+
+    response = test_app.get(f"/{app_settings.OPENEO_VERSION}/file_formats")
+
+    assert response.status_code == 200
+
+
 def test_exception_handler(core_api):
     test_client = TestClient(core_api.app)
 
@@ -98,7 +118,17 @@ def list_files(
 
     extended_register = ExtendedFileRegister(app_settings, test_links)
 
+    formats = [
+        FileFormat(
+            title="json",
+            gis_data_types=[GisDataType("vector")],
+            parameters={},
+        )
+    ]
+
     client = OpenEOCore(
+        input_formats=formats,
+        output_formats=formats,
         links=[
             Link(
                 href="https://eodc.eu/",
@@ -171,7 +201,17 @@ def get_file_headers(
     assert len(extended_register.endpoints) == 5
     assert new_endpoint in extended_register.endpoints
 
+    formats = [
+        FileFormat(
+            title="json",
+            gis_data_types=[GisDataType("vector")],
+            parameters={},
+        )
+    ]
+
     client = OpenEOCore(
+        input_formats=formats,
+        output_formats=formats,
         links=[
             Link(
                 href="https://eodc.eu/",

tests/conftest.py

@@ -44,7 +44,7 @@
 os.environ["OIDC_ROLES"] = "tester,developer"
 
 from openeo_fastapi.api.app import OpenEOApi
-from openeo_fastapi.api.types import Billing, Link, Plan
+from openeo_fastapi.api.types import Billing, FileFormat, GisDataType, Link, Plan
 from openeo_fastapi.client import auth, settings
 from openeo_fastapi.client.core import CollectionRegister, OpenEOCore
 
@@ -56,7 +56,16 @@ def app_settings():
 
 @pytest.fixture()
 def core_api():
+    formats = [
+        FileFormat(
+            title="json",
+            gis_data_types=[GisDataType("vector")],
+            parameters={},
+        )
+    ]
     client = OpenEOCore(
+        input_formats=formats,
+        output_formats=formats,
         links=[
             Link(
                 href="https://eodc.eu/",