Skip to content

Commit

Permalink
Merge pull request #893 from openmobilityfoundation/release-2.0.1
Browse files Browse the repository at this point in the history
Release 2.0.1
  • Loading branch information
schnuerle authored Dec 18, 2023
2 parents a4c2276 + e2d1916 commit ec4f010
Show file tree
Hide file tree
Showing 5 changed files with 88 additions and 47 deletions.
28 changes: 28 additions & 0 deletions ReleaseNotes.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,31 @@
## 2.0.1

> Release 2023-12-18
The 2.0.1 release fixes some minor issues and typos to help make the specifcation clearer.

### CHANGES

See the closed PRs tagged with [Milestone 2.0.1](https://github.com/openmobilityfoundation/mobility-data-specification/pulls?q=is%3Apr+is%3Aclosed+milestone%3A2.0.1) and [Issues](https://github.com/openmobilityfoundation/mobility-data-specification/issues?q=is%3Aissue+milestone%3A2.0.1+is%3Aclosed) for a full list of changes.

**Minor updates**

- [#879](https://github.com/openmobilityfoundation/mobility-data-specification/issues/879) Clarify which vehicles are included in the MDS 2.0 /vehicles endpoint
- [#868](https://github.com/openmobilityfoundation/mobility-data-specification/issues/868) Correction of description vehicle events (car sharing) bug Car Share

**Typos and wording clarifications**

- [#880](https://github.com/openmobilityfoundation/mobility-data-specification/issues/880) Remove word "data" from provider response payload descriptions
- [#894](https://github.com/openmobilityfoundation/mobility-data-specification/issues/894) Fixing broken links in data-types markdown document
- [#876](https://github.com/openmobilityfoundation/mobility-data-specification/issues/876) Reports endpoint - START_DATE clarification
- [#884](https://github.com/openmobilityfoundation/mobility-data-specification/issues/884) Fix JSON key in /vehicles/status example response
- [#878](https://github.com/openmobilityfoundation/mobility-data-specification/issues/878) Update "status changes" to "events" in provider

**Identifier updates**

- [#872](https://github.com/openmobilityfoundation/mobility-data-specification/issues/872) Add GBFS endpoint for Whoosh
- [#890](https://github.com/openmobilityfoundation/mobility-data-specification/issues/890) Add Nextbike

## 2.0.0

> Released 2023-05-09
Expand Down
20 changes: 10 additions & 10 deletions data-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This MDS data types page catalogs the objects (fields, types, requirements, desc
- [Propulsion Types](#propulsion-types)
- [Vehicle Status](#vehicle-status)
- [Events](#events)
- [Event Types](#event-times)
- [Event Times](#event-times)
- [Telemetry](#telemetry)
- [GPS Data][gps]
- [Stops](#stops)
Expand Down Expand Up @@ -108,7 +108,7 @@ Events represent changes in vehicle status.
| `event_types` | Enum[] | Required | Vehicle [event types][vehicle-events] for state change, with allowable values determined by `vehicle_state` |
| `timestamp` | [Timestamp][ts] | Required | Date/time that event occurred at. See [Event Times][event-times] |
| `publication_time` | [Timestamp][ts] | Optional | Date/time that event became available through the status changes endpoint |
| `location` | [GPS][gps] | Required | See also [Stop-based Geographic Data][stop-based-geo]. |
| `location` | [GPS][gps] | Required | See also [Telemetry][telemetry]. |
| `event_geographies` | UUID[] | Optional | **[Beta feature](/general-information.md#beta-features):** *Yes (as of 2.0.0)*. Array of Geography UUIDs consisting of every Geography that contains the location of the status change. See [Geography Driven Events][geography-driven-events]. Required if `location` is not present. |
| `battery_percent` | Integer | Required if Applicable | Percent battery charge of vehicle, expressed between 0 and 100 |
| `fuel_percent` | Integer | Required if Applicable | Percent fuel in vehicle, expressed between 0 and 100 |
Expand Down Expand Up @@ -247,11 +247,11 @@ A Report is defined by the following structure:
| Column Name | Type | Comments |
|----------------------| ----------------------------------------- | ------------------------------------------------ |
| `provider_id` | UUID | A UUID for the Provider, unique within MDS. See MDS provider_id in [provider list](/providers.csv). |
| `start_date` | date | Start date of trip the data row, ISO 8601 date format, i.e. YYYY-MM-DD |
| `start_date` | date | Start date of the [Trip](#trips) data row, in ISO 8601 date format, i.e. YYYY-MM-DD |
| `duration` | string | Value is always `P1M` for monthly. Based on [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) |
| `special_group_type` | [Special Group Type](#special-group-type) | Type that applies to this row |
| `geography_id` | [Geography](/geography) | ID that applies to this row. Includes all IDs in /geography. When there is no /geography then return `null` for this value and return counts based on the entire operating area. |
| `vehicle_type` | [Vehicle Type](/general-information.md#vehicle-types) | Type that applies to this row |
| `vehicle_type` | [Vehicle Type][vehicle-types] | Type that applies to this row |
| `trip_count` | integer | Count of trips taken for this row |
| `rider_count` | integer | Count of unique riders for this row |

Expand Down Expand Up @@ -294,18 +294,18 @@ Other special group types may be added in future MDS releases as relevant agency
[Top][toc]

[costs-and-currencies]: /general-information.md#costs-and-currencies
[event-times]: /general-information.md#event-times
[event-times]: #event-times
[gbfs-station-info]: https://github.com/NABSA/gbfs/blob/master/gbfs.md#station_informationjson
[gbfs-station-status]: https://github.com/NABSA/gbfs/blob/master/gbfs.md#station_statusjson
[geography-driven-events]: /general-information.md#geography-driven-events
[gps]: #gps-data
[iso4217]: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
[modes]: /modes/README.md
[propulsion-types]: /general-information.md#propulsion-types
[stop-based-geo]: #stop-based-geographic-data
[propulsion-types]: #propulsion-types
[stops]: #stops
[telemetry]: #telemetry
[toc]: #table-of-contents
[ts]: /general-information.md#timestamps
[vehicle-states]: /modes#vehicle-states
[vehicle-events]: /modes#event-types
[vehicle-types]: /general-information.md#vehicle-types
[vehicle-states]: /general-information.md#vehicle-states
[vehicle-events]: /general-information.md#event-types
[vehicle-types]: #vehicle-types
8 changes: 4 additions & 4 deletions modes/car-share.md
Original file line number Diff line number Diff line change
Expand Up @@ -241,10 +241,10 @@ This is the list of `vehicle_state` and `event_type` pairings that constitute th
| `reserved` | `available` | N/A | `provider_cancellation` | The provider has canceled the reservation |
| `reserved` | `elsewhere` | N/A | `trip_leave_jurisdiction` | The vehicle has left the jurisdiction while in a reservation |
| `reserved` | `non_contactable` | N/A | `comms_lost` | The vehicle went out of comms while being reserved by a passenger |
| `reserved` | `stopped` | `stopped` | `reservation_stop` | The vehicle has stopped to pick up the passenger |
| `stopped` | `available` | N/A | `driver_cancellation` | The driver has canceled the trip while either waiting for the passenger, or dropping them off |
| `stopped` | `available` | N/A | `customer_cancellation` | The customer has canceled the trip while the vehicle is waiting to pick them up, or they are being dropped off |
| `stopped` | `available` | N/A | `provider_cancellation` | The provider has canceled the trip while the vehicle is waiting for a passenger, or dropping them off |
| `reserved` | `stopped` | `stopped` | `reservation_stop` | The customer has activated the vehicle |
| `stopped` | `available` | N/A | `driver_cancellation` | The driver has canceled the trip |
| `stopped` | `available` | N/A | `customer_cancellation` | The customer has canceled the trip |
| `stopped` | `available` | N/A | `provider_cancellation` | The provider has canceled the trip |
| `stopped` | `available` | N/A | `trip_end` | The trip has been successfully completed |
| `stopped` | `non_contactable` | N/A | `comms_lost` | The vehicle has went out of comms while stopped |
| `stopped` | `on_trip` | `on_trip` | `trip_resume` | Resume a trip that was previously stopped (e.g. picking up a friend to go to the airport with) |
Expand Down
Loading

0 comments on commit ec4f010

Please sign in to comment.