Skip to content

Commit 6389ec7

Browse files
committed
Added documentation
1 parent c7020ff commit 6389ec7

File tree

1 file changed

+31
-0
lines changed
  • functions-python/tasks_executor/src/tasks/pmtiles_builder

1 file changed

+31
-0
lines changed
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Build pmtile for a specific GTFS dataset
2+
3+
This task generates the pmtiles for a provided dataset.
4+
pmtiles are used for displaying routes and stops in the UI
5+
6+
## Task ID
7+
Use task Id: `build_pmtiles`
8+
9+
## Usage
10+
The function receive the following payload:
11+
```
12+
{
13+
"feed_stable_id": str,
14+
"dataset_stable_id*: str
15+
}
16+
```
17+
18+
Example:
19+
```json
20+
{
21+
"feed_stable_id": "mdb-1004",
22+
"dataset_stable_id": "mdb-1004-202507081807"
23+
}
24+
```
25+
26+
The task will verify that the dataset stable id starts with the feed stable id (mdb-1004 in our example)
27+
28+
# GCP environment variables
29+
The function uses the following environment variables:
30+
- `ENV`: The environment to use. It can be `dev`, `staging` or `prod`. Default is `dev`.
31+
- `DATASETS_BUCKET_NAME`: The bucket name where the datasets are stored. The task will fail if this is not defined. The variable has to include the suffix, like `-dev`, `-qa` or `-prod`.

0 commit comments

Comments
 (0)