aboutsummaryrefslogtreecommitdiff
path: root/data/README.md
blob: 6aa2e10622224eaf67243e5d126928ae0975a3be (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
# Bus Stop Overrides

This file defines custom overrides for specific bus stops in YAML format.

## Format

```yaml
stopId:            # Numeric ID of the stop to override
    name:            # Override the name (string)
    alternateNames:  # Additional names for the stop (map)
        key:         # e.g. name used in metro maps
    location:        # Override location coordinates (map)
        latitude:      # New latitude value (float)
        longitude:     # New longitude value (float)
    hide:            # Hide the stop from the map and list (boolean)
    amenities:       # List of amenities available at this stop (list)
        - shelter
        - display
```

## Field Descriptions

- **stopId** (integer): Unique identifier of the bus stop.  
- **alternateNames** (object): Other names used in different contexts.
    - **key** (string): Name used in a specific context, such as `metro`.
- **location** (object):
    - **latitude** (float): Override latitude coordinate.  
    - **longitude** (float): Override longitude coordinate.  
- **hide** (boolean): Set to `true` to exclude the stop from maps and listings.  
- **amenities** (array of strings): Amenities available at this stop, such as `shelter` or `display`. For now, only those two will be supported in the app.

## Example

```yaml
12345:
    name: "Central Station"
    alternateNames:
        metro: "Main Hub"
    location:
        latitude: 40.712776
        longitude: -74.005974
    hide: false
    amenities:
        - shelter
        - real-time display
```