diff --git a/docs/specification/index.md b/docs/specification/index.md index 0283f26..a795aff 100644 --- a/docs/specification/index.md +++ b/docs/specification/index.md @@ -1,14 +1,14 @@ # Specification
- Latest Reference (v3.0-RC2-Draft)Change ProposalsGovernance Process + Latest Reference (v3.0-RC2)Change ProposalsGovernance Process
## Versions of this documentation -- [Latest](reference) - Version 3.0-RC2-Draft (Future Version) +- [Latest](reference) - Version 3.0-RC2 - [v3.0-RC](https://github.com/MobilityData/gbfs/blob/v3.0-RC/gbfs.md) - Version 3.0-RC - [v2.3](https://github.com/MobilityData/gbfs/blob/v2.3/gbfs.md) - Version 2.3 - [v2.2](https://github.com/MobilityData/gbfs/blob/v2.2/gbfs.md) - Version 2.2 diff --git a/docs/specification/reference.md b/docs/specification/reference.md index b7b12fd..ee828e8 100644 --- a/docs/specification/reference.md +++ b/docs/specification/reference.md @@ -4,7 +4,7 @@ This document explains the types of files and data that comprise the General Bik ## Reference version -This documentation refers to **v3.0-RC2-Draft (Future Version)**. +This documentation refers to **v3.0-RC2**. **For the current version see [**version 2.3**](https://github.com/MobilityData/gbfs/blob/v2.3/gbfs.md).** For past and upcoming versions see the [README](https://github.com/MobilityData/gbfs/blob/master/README.md#current-version-recommended). @@ -235,11 +235,11 @@ Example: `Asia/Tokyo`, `America/Los_Angeles` or `Africa/Cairo`. To accommodate the needs of feed producers and consumers prior to the adoption of a change, additional fields can be added to feeds even if these fields are not part of the official specification. Custom extensions that may provide value to the GBFS community and align with the [GBFS Guiding Principles](https://github.com/MobilityData/gbfs/blob/master/README.md#guiding-principles) SHOULD be proposed for inclusion in the specification through the change process. Extreme caution is advised to avoid introducing extensions which may be used to track the movements of vehicles or their users. -Field names of extensions SHOULD be prefixed with an underscore ( _ ) character. It is strongly RECOMMENDED that these additional fields be documented on the [wiki](https://github.com/MobilityData/gbfs/wiki) page of the GBFS repository in this format: +Field names of extensions SHOULD be prefixed with an underscore (_) character. It is strongly RECOMMENDED that these additional fields be documented on [gbfs.org](https://gbfs.org/specification/#extensions-outside-of-the-specification) in this format: -Submitted by | Field Name | File Name | Defines +Field Name | File Name | Organization name | Defines ---|---|---|--- -Publisher's name|_field_name|Name of GBFS endpoint where field is used|Description of purpose of use +_field_name | Name of GBFS endpoint where field is used | Publisher's name | Description of purpose or use ## JSON Files @@ -520,9 +520,9 @@ Field Name | REQUIRED | Type | Defines \- `cargo_volume_capacity`
*(added in v2.3)* | OPTIONAL | Non-negative integer | Cargo volume available in the vehicle, expressed in liters. For cars, it corresponds to the space between the boot floor, including the storage under the hatch, to the rear shelf in the trunk. \- `cargo_load_capacity`
*(added in v2.3)* | OPTIONAL | Non-negative integer | The capacity of the vehicle cargo space (excluding passengers), expressed in kilograms. \- `propulsion_type` | Yes | Enum | The primary propulsion type of the vehicle.

Current valid values are:
This field was inspired by, but differs from the propulsion types field described in the [Open Mobility Foundation Mobility Data Specification](https://github.com/openmobilityfoundation/mobility-data-specification/blob/main/general-information.md#propulsion-types). -\- `eco_label`
*(added in v2.3)* | OPTIONAL | Array | Vehicle air quality certificate. Official anti-pollution certificate, based on the information on the vehicle's registration certificate, attesting to its level of pollutant emissions based on a defined standard. In Europe, for example, it is the European emission standard. The aim of this measure is to encourage the use of the least polluting vehicles by allowing them to drive during pollution peaks or in low emission zones.

Each element in the array is an object with the keys below. - \-  `country_code`
*(added in v2.3)*| Conditionally REQUIRED | Country code | REQUIRED if `eco_label` is defined. Country where the `eco_sticker` applies. - \-  `eco_sticker`
*(added in v2.3)* | Conditionally REQUIRED | String | REQUIRED if `eco_label` is defined. Name of the eco label. The name must be written in lowercase, separated by an underscore.

Example of `eco_sticker` in Europe : +\- `eco_labels`
*(as of v3.0-RC2)* | OPTIONAL | Array | Vehicle air quality certificate. Official anti-pollution certificate, based on the information on the vehicle's registration certificate, attesting to its level of pollutant emissions based on a defined standard. In Europe, for example, it is the European emission standard. The aim of this measure is to encourage the use of the least polluting vehicles by allowing them to drive during pollution peaks or in low emission zones.

Each element in the array is an object with the keys below. + \-  `country_code`
*(added in v2.3)*| Conditionally REQUIRED | Country code | REQUIRED if `eco_labels` is defined. Country where the `eco_sticker` applies. + \-  `eco_sticker`
*(added in v2.3)* | Conditionally REQUIRED | String | REQUIRED if `eco_labels` is defined. Name of the eco label. The name must be written in lowercase, separated by an underscore.

Example of `eco_sticker` in Europe : \- `max_range_meters` | Conditionally REQUIRED | Non-negative float | If the vehicle has a motor (as indicated by having a value other than `human` in the `propulsion_type` field), this field is REQUIRED. This represents the furthest distance in meters that the vehicle can travel without recharging or refueling when it has the maximum amount of energy potential (for example, a full battery or full tank of gas). \- `name`
*(as of v3.0-RC)* | OPTIONAL | Array<Localized String> | The public name of this vehicle type. \- `vehicle_accessories`
*(added in v2.3)* | OPTIONAL | Array | Description of accessories available in the vehicle. These accessories are part of the vehicle and are not supposed to change frequently. Current valid values are: @@ -638,7 +638,7 @@ Field Name | REQUIRED | Type | Defines "rider_capacity": 5, "cargo_volume_capacity": 200, "propulsion_type": "combustion_diesel", - "eco_label": [ + "eco_labels": [ { "country_code": "FR", "eco_sticker": "critair_1"