Skip to content

Defaults

defaults apply default features to all vehicles and stops. Properties added to specific vehicles or stops override the default settings, when both are present. Please reference the vehicle schema and stop schema to see which features are configurable via defaults.

Here is an example of using features for vehicles and stops.

{
  "defaults": {
    "vehicles": {
      "speed": 15,
      "max_stops": 2,
      "start_time": "2023-01-01T12:00:00Z",
      "start_location": {
        "lon": 135.772695,
        "lat": 34.967146
      },
      "end_location": {
        "lon": 135.772695,
        "lat": 34.967146
      }
    },
    "stops": {
      "target_arrival_time": "2023-01-01T12:20:00Z",
      "duration": 300,
      "unplanned_penalty": 5000000,
      "early_arrival_time_penalty": 1.5,
      "late_arrival_time_penalty": 1.5
    }
  },
  "stops": [
    {
      "id": "Fushimi Inari Taisha",
      "location": { "lon": 135.772695, "lat": 34.967146 }
    },
    {
      "id": "Kiyomizu-dera",
      "location": { "lon": 135.78506, "lat": 34.994857 }
    },
    {
      "id": "Nijō Castle",
      "location": { "lon": 135.748134, "lat": 35.014239 }
    },
    {
      "id": "Kyoto Imperial Palace",
      "location": { "lon": 135.762057, "lat": 35.025431 },
      "compatibility_attributes": ["category_1"],
      "precedes": "Fushimi Inari Taisha"
    },
    {
      "id": "Gionmachi",
      "location": { "lon": 135.775682, "lat": 35.002457 },
      "compatibility_attributes": ["category_3"]
    },
    {
      "id": "Kinkaku-ji",
      "location": { "lon": 135.728898, "lat": 35.039705 },
      "compatibility_attributes": ["category_2"],
      "precedes": "Kiyomizu-dera"
    },
    {
      "id": "Arashiyama Bamboo Forest",
      "location": { "lon": 135.672009, "lat": 35.017209 },
      "compatibility_attributes": ["category_4"],
      "precedes": "Nijō Castle"
    }
  ],
  "vehicles": [
    {
      "id": "v1",
      "compatibility_attributes": ["category_1"]
    },
    {
      "id": "v2",
      "compatibility_attributes": ["category_2"]
    },
    {
      "id": "v3",
      "compatibility_attributes": ["category_3"]
    },
    {
      "id": "v4",
      "compatibility_attributes": ["category_4"]
    }
  ]
}

Visit the defaults schema for detailed information.