Skip to content

Commit

Permalink
Make vehicle_type_ids plural in geofencing_zones (#542)
Browse files Browse the repository at this point in the history
* Make vehicle_type_ids plural in geofencing_zones
  • Loading branch information
richfab committed Nov 2, 2023
1 parent 0570224 commit 5c07bdf
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions gbfs.md
Original file line number Diff line number Diff line change
Expand Up @@ -1340,7 +1340,7 @@ A `Rule` object defines the set of restrictions in place for a particular zone.

Field Name | REQUIRED | Type | Defines
---|---|---|---
`vehicle_type_id` | OPTIONAL | Array | Array of IDs of vehicle types for which any restrictions SHOULD be applied (see vehicle type definitions in `vehicle_types.json`). If vehicle type IDs are not specified, then restrictions apply to all vehicle types.
`vehicle_type_ids` <br/>*(as of v3.0-RC2)* | OPTIONAL | Array | Array of IDs of vehicle types for which any restrictions SHOULD be applied (see vehicle type definitions in `vehicle_types.json`). If vehicle type IDs are not specified, then restrictions apply to all vehicle types.
`ride_start_allowed` | REQUIRED | Boolean | Is the ride allowed to start in this zone? <br /><br /> `true` - Ride can start in this zone. <br /> `false` - Ride cannot start in this zone.
`ride_end_allowed` | REQUIRED | Boolean | Is the ride allowed to end in this zone? <br /><br /> `true` - Ride can end in this zone. <br /> `false` - Ride cannot end in this zone.
`ride_through_allowed` | REQUIRED | Boolean | Is the ride allowed to travel through this zone? <br /><br /> `true` - Ride can travel through this zone. <br /> `false` - Ride cannot travel through this zone.
Expand All @@ -1349,7 +1349,7 @@ Field Name | REQUIRED | Type | Defines

#### Geofencing Rule Precedence

Geofencing [Rule](#geofencing-rule-object) objects are specified within arrays for the `rules` and `global_rules` fields of `geofencing_zones.json` to allow for different restrictions for different vehicle types. When multiple rules in the same array apply to a particular vehicle type, per the semantics of the `vehicle_type_id` field, then the earlier rule (in order of the JSON file) takes precedence for that vehicle type.
Geofencing [Rule](#geofencing-rule-object) objects are specified within arrays for the `rules` and `global_rules` fields of `geofencing_zones.json` to allow for different restrictions for different vehicle types. When multiple rules in the same array apply to a particular vehicle type, per the semantics of the `vehicle_type_ids` field, then the earlier rule (in order of the JSON file) takes precedence for that vehicle type.

When multiple overlapping polygons define rules that apply to a particular vehicle type, then the rules from the earlier polygon (in order of the JSON file) takes precedence for that vehicle type in the overlapping area. Polygons with inactive time ranges should be excluded from consideration when considering precedence.

Expand Down Expand Up @@ -1434,7 +1434,7 @@ See examples below.
"end": "2024-07-18T13:34:13+02:00",
"rules": [
{
"vehicle_type_id": [
"vehicle_type_ids": [
"moped1",
"car1"
],
Expand Down Expand Up @@ -1477,7 +1477,7 @@ In the examples below, only a minimal set of fields are specified for clarity.
"properties": {
"rules": [
{
"vehicle_type_id": ["bike"],
"vehicle_type_ids": ["bike"],
"ride_through_allowed": true
}
]
Expand All @@ -1488,7 +1488,7 @@ In the examples below, only a minimal set of fields are specified for clarity.
"properties": {
"rules": [
{
"vehicle_type_id": ["bike"],
"vehicle_type_ids": ["bike"],
"ride_through_allowed": false,
"maximum_speed_kph": 20
}
Expand All @@ -1498,7 +1498,7 @@ In the examples below, only a minimal set of fields are specified for clarity.
],
"global_rules": [
{
"vehicle_type_id": ["bike"],
"vehicle_type_ids": ["bike"],
"ride_through_allowed": false,
"maximum_speed_kph": 10
}
Expand All @@ -1525,7 +1525,7 @@ g | bike | false | 10
"properties": {
"rules": [
{
"vehicle_type_id": ["bike"],
"vehicle_type_ids": ["bike"],
"ride_through_allowed": true
}
]
Expand All @@ -1536,7 +1536,7 @@ g | bike | false | 10
"properties": {
"rules": [
{
"vehicle_type_id": ["scooter"],
"vehicle_type_ids": ["scooter"],
"ride_through_allowed": false
}
]
Expand All @@ -1545,11 +1545,11 @@ g | bike | false | 10
],
"global_rules": [
{
"vehicle_type_id": ["bike"],
"vehicle_type_ids": ["bike"],
"ride_through_allowed": false
},
{
"vehicle_type_id": ["scooter"],
"vehicle_type_ids": ["scooter"],
"ride_through_allowed": true
}
]
Expand Down Expand Up @@ -1578,7 +1578,7 @@ g | scooter | true
"properties": {
"rules": [
{
"vehicle_type_id": ["bike", "scooter"],
"vehicle_type_ids": ["bike", "scooter"],
"ride_through_allowed": true
}
]
Expand All @@ -1589,7 +1589,7 @@ g | scooter | true
"properties": {
"rules": [
{
"vehicle_type_id": ["scooter"],
"vehicle_type_ids": ["scooter"],
"ride_through_allowed": false
}
]
Expand Down

0 comments on commit 5c07bdf

Please sign in to comment.