REST: Add spatial expressions to REST Catalog OpenAPI Spec

open-api/rest-catalog-open-api.py

@@ -133,6 +133,8 @@ class ExpressionType(BaseModel):
             'not-null',
             'is-nan',
             'not-nan',
+            'st-intersects',
+            'st-disjoint',
         ],
     )
 
@@ -145,6 +147,11 @@ class FalseExpression(BaseModel):
     type: str = Field('false', const=True)
 
 
+class CoordinateRange(BaseModel):
+    min: float
+    max: float
+
+
 class Reference(BaseModel):
     __root__: str = Field(..., example=['column-name'])
 
@@ -997,6 +1004,13 @@ class RenameTableRequest(BaseModel):
     destination: TableIdentifier
 
 
+class BoundingBox(BaseModel):
+    x: CoordinateRange
+    y: CoordinateRange
+    z: Optional[CoordinateRange] = None
+    m: Optional[CoordinateRange] = None
+
+
 class TransformTerm(BaseModel):
     type: str = Field('transform', const=True)
     transform: Transform
@@ -1123,6 +1137,12 @@ class SetExpression(BaseModel):
     values: List[PrimitiveTypeValue]
 
 
+class SpatialExpression(BaseModel):
+    type: Literal['st-intersects', 'st-disjoint']
+    term: Term
+    value: BoundingBox
+
+
 class ResidualFilter6(SetExpression, ResidualFilter1):
     """
     An optional filter to be applied to rows in this file scan task.
@@ -1144,6 +1164,13 @@ class ResidualFilter8(UnaryExpression, ResidualFilter1):
     """
 
 
+class ResidualFilter9(SpatialExpression, ResidualFilter1):
+    """
+    An optional filter to be applied to rows in this file scan task.
+    If the residual is not present, the client must produce the residual or use the original filter.
+    """
+
+
 class StructField(BaseModel):
     id: int
     name: str
@@ -1188,6 +1215,7 @@ class Expression(BaseModel):
         SetExpression,
         LiteralExpression,
         UnaryExpression,
+        SpatialExpression,
     ]
 
 
@@ -1544,6 +1572,7 @@ class ResidualFilter(BaseModel):
         ResidualFilter6,
         ResidualFilter7,
         ResidualFilter8,
+        ResidualFilter9,
     ] = Field(
         ...,
         description='An optional filter to be applied to rows in this file scan task.\nIf the residual is not present, the client must produce the residual or use the original filter.',

open-api/rest-catalog-open-api.yaml

@@ -2252,6 +2252,7 @@ components:
         - $ref: '#/components/schemas/SetExpression'
         - $ref: '#/components/schemas/LiteralExpression'
         - $ref: '#/components/schemas/UnaryExpression'
+        - $ref: '#/components/schemas/SpatialExpression'
 
     ExpressionType:
       type: string
@@ -2275,6 +2276,8 @@ components:
         - "not-null"
         - "is-nan"
         - "not-nan"
+        - "st-intersects"
+        - "st-disjoint"
 
     TrueExpression:
       type: object
@@ -2365,6 +2368,49 @@ components:
           items:
             $ref: '#/components/schemas/PrimitiveTypeValue'
 
+    SpatialExpression:
+      type: object
+      required:
+        - type
+        - term
+        - value
+      properties:
+        type:
+          $ref: '#/components/schemas/ExpressionType'
+          enum: ["st-intersects", "st-disjoint"]
+        term:
+          $ref: '#/components/schemas/Term'
+        value:
+          $ref: '#/components/schemas/BoundingBox'
+
+    BoundingBox:
+      type: object
+      required:
+        - x
+        - y
+      properties:
+        x:
+          $ref: '#/components/schemas/CoordinateRange'
+        y:
+          $ref: '#/components/schemas/CoordinateRange'
+        z:
+          $ref: '#/components/schemas/CoordinateRange'
+        m:
+          $ref: '#/components/schemas/CoordinateRange'
+
+    CoordinateRange:
+      type: object
+      required:
+        - min
+        - max
+      properties:
+        min:
+          type: number
+          format: double
+        max:
+          type: number
+          format: double
+
     Term:
       oneOf:
         - $ref: '#/components/schemas/Reference'