Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add optional station_parking rule to geofencing_zones.json #349

Merged
merged 1 commit into from
Dec 15, 2021
Merged

Add optional station_parking rule to geofencing_zones.json #349

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion gbfs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1009,6 +1009,7 @@ Field Name | REQUIRED | Type | Defines
&emsp;&emsp;&emsp;\-&nbsp;`ride_allowed` | Conditionally REQUIRED | Boolean | REQUIRED if `rules` array is defined. Is the undocked (“free bike”) ride allowed to start and end in this zone? <br /><br /> `true` - Undocked (“free bike”) ride can start and end in this zone. <br /> `false` - Undocked (“free bike”) ride cannot start and end in this zone.
&emsp;&emsp;&emsp;\-&nbsp;`ride_through_allowed` | Conditionally REQUIRED | Boolean | REQUIRED if `rules` array is defined. 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.
&emsp;&emsp;&emsp;\-&nbsp;`maximum_speed_kph` | OPTIONAL | Non-negative Integer | What is the maximum speed allowed, in kilometers per hour? <br /><br /> If there is no maximum speed to observe, this can be omitted.
&emsp;&emsp;&emsp;\-&nbsp;`station_parking` | OPTIONAL | Boolean | Vehicle MUST be parked at stations defined in station_information.json within this geofence zone? <br /><br />`true` - MUST only be parked at stations. <br /> `false` - MAY be parked outside of stations.
Copy link
Contributor

@testower testower Dec 6, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This usage of capitalized keywords "MUST" and "MAY" seems non-standard. These capitalized keywords are used for describing the spec, and not for the semantics of the data itself.

I suggest this:

Can the vehicle only be parked at stations defined in station_information.json within this geofence zone?

true - Can only be parked at stations.
false - May be parked outside of stations.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for catching this, @testower . We will make sure it is corrected before merging. @viestat - could you update the language?


##### Example:

Expand Down Expand Up @@ -1088,7 +1089,8 @@ Field Name | REQUIRED | Type | Defines
],
"ride_allowed": false,
"ride_through_allowed": true,
"maximum_speed_kph": 10
"maximum_speed_kph": 10,
"station_parking": true
}
]
}
Expand Down