add queryables endpoint

Author: vincentsarago

tifeatures/factory.py

@@ -179,6 +179,16 @@ def landing(
                         type=MediaType.json,
                         rel="data",
                     ),
+                    model.Link(
+                        title="Collection queryables",
+                        href=self.url_for(
+                            request,
+                            "queryables",
+                            collectionId="{collectionId}",
+                        ),
+                        type=MediaType.schemajson,
+                        rel="queryables",
+                    ),
                     model.Link(
                         title="Collection Features",
                         href=self.url_for(
@@ -245,6 +255,7 @@ def conformance(
                     "http://www.opengis.net/spec/ogcapi-common-2/1.0/conf/collections",
                     "http://www.opengis.net/spec/ogcapi-common-2/1.0/conf/simple-query",
                     "http://www.opengis.net/spec/ogcapi-features-3/1.0/conf/filter,",
+                    "http://www.opengis.net/def/rel/ogc/1.0/queryables",
                 ]
             )
             if output_type and output_type == ResponseType.html:
@@ -323,6 +334,15 @@ def collections(
                                     rel="items",
                                     type=MediaType.geojson,
                                 ),
+                                model.Link(
+                                    href=self.url_for(
+                                        request,
+                                        "queryables",
+                                        collectionId=collection.id,
+                                    ),
+                                    rel="queryables",
+                                    type=MediaType.schemajson,
+                                ),
                             ],
                         }
                     )
@@ -378,6 +398,15 @@ def collection(
                             rel="items",
                             type=MediaType.geojson,
                         ),
+                        model.Link(
+                            href=self.url_for(
+                                request,
+                                "queryables",
+                                collectionId=collection.id,
+                            ),
+                            rel="queryables",
+                            type=MediaType.schemajson,
+                        ),
                     ],
                 }
             )
@@ -391,6 +420,51 @@ def collection(
 
             return data
 
+        @self.router.get(
+            "/collections/{collectionId}/queryables",
+            response_model=model.Queryables,
+            response_model_exclude_none=True,
+            response_model_by_alias=True,
+            responses={
+                200: {
+                    "content": {
+                        "text/html": {},
+                        "application/schema+json": {},
+                    }
+                },
+            },
+        )
+        def queryables(
+            request: Request,
+            collection=Depends(self.collection_dependency),
+            output_type: Optional[ResponseType] = Depends(OutputType),
+        ):
+            """Queryables for a feature collection.
+
+            ref: http://docs.ogc.org/DRAFTS/19-079r1.html#filter-queryables
+            """
+            qs = "?" + str(request.query_params) if request.query_params else ""
+
+            data = model.Queryables(
+                **{
+                    "title": collection.id,
+                    "$id": self.url_for(
+                        request, "queryables", collectionId=collection.id
+                    )
+                    + qs,
+                    "properties": collection.queryables,
+                }
+            )
+
+            if output_type and output_type == ResponseType.html:
+                return create_html_response(
+                    request,
+                    data.json(exclude_none=True),
+                    template_name="collection",
+                )
+
+            return data
+
         @self.router.get(
             "/collections/{collectionId}/items",
             response_model=model.Items,

tifeatures/layer.py

@@ -24,6 +24,18 @@
 from tifeatures.filter.evaluate import to_filter
 from tifeatures.filter.filters import bbox_to_wkt
 
+# Links to geojson schema
+geojson_schema = {
+    "GEOMETRY": "https://geojson.org/schema/Geometry.json",
+    "POINT": "https://geojson.org/schema/Point.json",
+    "MULTIPOINT": "https://geojson.org/schema/MultiPoint.json",
+    "LINESTRING": "https://geojson.org/schema/LineString.json",
+    "MULTILINESTRING": "https://geojson.org/schema/MultiLineString.json",
+    "POLYGON": "https://geojson.org/schema/Polygon.json",
+    "MULTIPOLYGON": "https://geojson.org/schema/MultiPolygon.json",
+    "GEOMETRYCOLLECTION": "https://geojson.org/schema/GeometryCollection.json",
+}
+
 
 class CollectionLayer(BaseModel, metaclass=abc.ABCMeta):
     """Layer's Abstract BaseClass.
@@ -69,6 +81,11 @@ async def feature(
         """Return a Feature."""
         ...
 
+    @property
+    def queryables(self) -> Dict:
+        """Return the queryables."""
+        ...
+
 
 class Table(CollectionLayer, DBTable):
     """Table Reader.
@@ -412,6 +429,22 @@ async def feature(
 
         return None
 
+    @property
+    def queryables(self) -> Dict:
+        """Return the queryables."""
+        geometries = self.geometry_columns or []
+        print(geometries)
+        geoms = {
+            col.name: {"$ref": geojson_schema.get(col.geometry_type.upper(), "")}
+            for col in geometries
+        }
+        props = {
+            col.name: {"name": col.name, "type": col.type}
+            for col in self.properties
+            if col.name not in geoms
+        }
+        return {**geoms, **props}
+
 
 class Function(CollectionLayer):
     """Function Reader.
@@ -475,6 +508,12 @@ async def feature(
         # TODO
         pass
 
+    @property
+    def queryables(self) -> Dict:
+        """Return the queryables."""
+        # TODO
+        pass
+
 
 @dataclass
 class FunctionRegistry:

tifeatures/model.py

@@ -1,9 +1,9 @@
 """tifeatures models."""
 
-from typing import List, Optional
+from typing import Dict, List, Optional
 
 from geojson_pydantic import Feature, FeatureCollection
-from pydantic import BaseModel
+from pydantic import BaseModel, Field
 
 from tifeatures.resources.enums import MediaType
 
@@ -154,3 +154,19 @@ class Landing(BaseModel):
     title: Optional[str]
     description: Optional[str]
     links: List[Link]
+
+
+class Queryables(BaseModel):
+    """Queryables model.
+
+    Ref: https://docs.ogc.org/DRAFTS/19-079r1.html#filter-queryables
+
+    """
+
+    title: str
+    properties: Dict[str, Dict[str, str]]
+    type: str = "object"
+    schema_name: str = Field(
+        "https://json-schema.org/draft/2019-09/schema", alias="$schema"
+    )
+    link: str = Field(..., alias="$id")

tifeatures/resources/enums.py

@@ -24,6 +24,7 @@ class MediaType(str, Enum):
     xml = "application/xml"
     json = "application/json"
     geojson = "application/geo+json"
+    schemajson = "application/schema+json"
     html = "text/html"
     text = "text/plain"
     openapi30_json = "application/vnd.oai.openapi+json;version=3.0"