Skip to content

Commit 1d90d3c

Browse files
committed
docs: added description for tiles model
1 parent b0a42c7 commit 1d90d3c

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

app/schemas/tiles.py

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
from enum import Enum
2-
from pydantic import BaseModel
2+
from pydantic import BaseModel, Field
33
from geojson_pydantic import Polygon
44

55

@@ -8,8 +8,14 @@ class GridTypeEnum(str, Enum):
88

99

1010
class TileRequest(BaseModel):
11-
aoi: Polygon
12-
grid: GridTypeEnum
11+
aoi: Polygon = Field(
12+
...,
13+
description="Polygon representing the area of interest for which the tiling grid should be calculated",
14+
)
15+
grid: GridTypeEnum = Field(
16+
...,
17+
description="Identifier of the grid system that needs to be used to split up the area of interest",
18+
)
1319

1420

1521
# class TileResponse(BaseModel):

0 commit comments

Comments
 (0)