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

Jump to bottom

Makes vehicle capacity at stations consistent between station_information and status #547

Merged
merged 12 commits into from
Nov 2, 2023
Merged

Makes vehicle capacity at stations consistent between station_information and status #547

Changes from 9 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
d7b5fd2
makes vehicle capacity at stations consistent
cmonagle Sep 27, 2023
fe3a7d7
Fixes formatting
cmonagle Sep 27, 2023
7f1ee05
Completes sentence with missing clause
cmonagle Oct 24, 2023
a8cad20
Adjusts field name for consistency
cmonagle Oct 25, 2023
eeb378a
Updates requirement status to be more consistent
cmonagle Oct 25, 2023
245dff5
Fixes formatting
cmonagle Oct 25, 2023
9f697bc
Use SHOULD (RFC2119) in vehicle_docks_capacity
richfab Oct 31, 2023
08b328a
Rename vehicle_type_area_capacity to vehicle_types_capacity
richfab Oct 31, 2023
e64219f
Remove extra space after vehicle_types_capacity
richfab Oct 31, 2023
a76a9c7
Adds that the change is as of v3.0
richfab Oct 31, 2023
3c21e96
Update vehicle_docks_capacity.count description
richfab Nov 2, 2023
97079cb
As of v3.0-RC2
richfab Nov 2, 2023
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
31 changes: 14 additions & 17 deletions gbfs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -709,12 +709,12 @@ Field Name | REQUIRED | Type | Defines
\-&nbsp;`parking_hoop`<br/>*(added in v2.3)* | OPTIONAL | Boolean | Are parking hoops present at this station?<br /><br />`true` - Parking hoops are present at this station.<br />`false` - Parking hoops are not present at this station.<br /><br />Parking hoops are lockable devices that are used to secure a parking space to prevent parking of unauthorized vehicles.
\-&nbsp;`contact_phone`<br/>*(added in v2.3)* | OPTIONAL | Phone number | Contact phone of the station.
\-&nbsp;`capacity` | OPTIONAL | Non-negative integer | Number of total docking points installed at this station, both available and unavailable, regardless of what vehicle types are allowed at each dock. <br/><br/>If this is a virtual station defined using the `is_virtual_station` field, this number represents the total number of vehicles of all types that can be parked at the virtual station.<br/><br/>If the virtual station is defined by `station_area`, this is the number that can park within the station area. If `lat`/`lon` are defined, this is the number that can park at those coordinates.
\-&nbsp;`vehicle_type_area_capacity` <br/>*(as of v3.0)* | OPTIONAL | Array| This field's value is an array of objects containing the keys `vehicle_type_id` and `count` defined below. These objects are used to model the parking capacity of virtual stations (defined using the `is_virtual_station` field) for each vehicle type defined in `vehicle_types.json`.
&emsp;&emsp;\-&nbsp;`vehicle_type_id`| Yes | ID | REQUIRED if `vehicle_type_area_capacity` is defined. A `vehicle_type_id`, as defined in `vehicle_types.json`, that may park at the virtual station.
&emsp;&emsp;\-&nbsp;`count`| Yes | Non-negative integer | REQUIRED if `vehicle_type_area_capacity` is defined. A number representing the total number of vehicles of the corresponding `vehicle_type_id` type that can park within the virtual station.<br /><br />If the virtual station is defined by `station_area`, this is the number that can park within the station area. If `lat`/`lon` is defined, this is the number that can park at those coordinates.
\-&nbsp;`vehicle_type_dock_capacity` <br/>*(as of v3.0)* | OPTIONAL | Array | This field's value is an array of objects containing the keys `vehicle_type_id` and `count` defined below. These objects are used to model the total docking capacity of a station, both available and unavailable, for each type of vehicle defined in `vehicle_types.json`.
&emsp;&emsp;\-&nbsp;`vehicle_type_id`| Yes | ID | REQUIRED if `vehicle_type_dock_capacity` is defined. A `vehicle_type_id`, as defined in `vehicle_types.json`, that may dock at the station.
&emsp;&emsp;\-&nbsp;`count`| Yes | Non-negative integer | REQUIRED if `vehicle_type_dock_capacity` is defined. The total number of docks at the station, both available and unavailable, that may accept the corresponding vehicle type as defined by its `vehicle_type_id`.
\-&nbsp;`vehicle_types_capacity` <br/>*(as of v3.0)* | OPTIONAL | Array | This field's value is an array of objects containing the keys `vehicle_type_ids` and `count` defined below. These objects are used to model the parking capacity of virtual stations (defined using the `is_virtual_station` field) for each vehicle type that can be returned to this station. The total number of vehicles from each of these objects SHOULD add up to match the value specified in the `capacity` field.
&emsp;&emsp;\-&nbsp;`vehicle_type_ids`| Conditionally REQUIRED | Array | REQUIRED if `vehicle_types_capacity` is defined. The `vehicle_type_ids`, as defined in `vehicle_types.json`, that may park at the virtual station.
richfab marked this conversation as resolved.
Show resolved Hide resolved
&emsp;&emsp;\-&nbsp;`count`| Conditionally REQUIRED | Non-negative integer | REQUIRED if `vehicle_types_capacity` is defined. A number representing the total number of vehicles of the specified `vehicle_type_ids` that can park within the virtual station.<br /><br />If the virtual station is defined by `station_area`, this is the number that can park within the station area. If `lat`/`lon` is defined, this is the number that can park at those coordinates.
\-&nbsp;`vehicle_docks_capacity` <br/>*(as of v3.0)* | OPTIONAL | Array | This field's value is an array of objects containing the keys `vehicle_type_ids` and `count` defined below. These objects are used to model the total docking capacity of a station, both available and unavailable, for each type of vehicle that may dock at this station. The total number of docks from each of these objects SHOULD add up to match the value specified in the `capacity` field.
&emsp;&emsp;\-&nbsp;`vehicle_type_ids` <br/>*(as of v3.0)* | Conditionally REQUIRED | Array | REQUIRED if `vehicle_docks_capacity` is defined. An array of strings where each string represents a `vehicle_type_id` that is able to use a particular type of dock at the station.
&emsp;&emsp;\-&nbsp;`count`| Conditionally REQUIRED | Non-negative integer | REQUIRED if `vehicle_docks_capacity` is defined. The total number of docks at the station, both available and unavailable, that may accept the corresponding vehicle type as defined by its `vehicle_type_id`.
richfab marked this conversation as resolved.
Show resolved Hide resolved
\-&nbsp;`is_valet_station` <br/>*(added in v2.1)* | OPTIONAL | Boolean | Are valet services provided at this station? <br /><br /> `true` - Valet services are provided at this station. <br /> `false` - Valet services are not provided at this station. <br /><br /> If this field is empty, it is assumed that valet services are not provided at this station. <br><br>This field’s boolean SHOULD be set to `true` during the hours which valet service is provided at the station. Valet service is defined as providing unlimited capacity at a station.
\-&nbsp;`is_charging_station` <br/>*(added in v2.3)* | OPTIONAL | Boolean | Does the station support charging of electric vehicles? <br /><br /> `true` - Electric vehicle charging is available at this station. <br /> `false` - Electric vehicle charging is not available at this station.
\-&nbsp;`rental_uris` | OPTIONAL | Object | Contains rental URIs for Android, iOS, and web in the `android`, `ios`, and `web` fields. See [examples](#deep-links-examples) of how to use these fields and [supported analytics](#analytics).
Expand Down Expand Up @@ -746,14 +746,10 @@ Field Name | REQUIRED | Type | Defines
"parking_hoop": false,
"contact_phone": "+33109874321",
"is_charging_station": true,
"vehicle_type_dock_capacity": [
"vehicle_docks_capacity": [
{
"vehicle_type_id": "abc123",
"vehicle_type_ids": ["abc123"],
"count": 7
},
{
"vehicle_type_id": "def456",
"count": 0
}
]
}
Expand Down Expand Up @@ -814,15 +810,16 @@ Field Name | REQUIRED | Type | Defines
]
},
"capacity": 16,
"vehicle_type_area_capacity": [
"vehicle_types_capacity": [
{
"vehicle_type_id": "abc123",
"count": 7
"vehicle_type_ids": ["abc123", "def456"],
"count": 15
},
{
"vehicle_type_id": "def456",
"count": 8
"vehicle_type_ids": ["def456"],
"count": 1
}

]
}
]
Expand Down