Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE/release-candidate.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ Please use this pull request to track Technology Council and OMF Board feedback

### Action Item

This pull request will be merged by an OMF maintainer after OMF Board Approval following the [Release Guidelines](https://github.com/openmobilityfoundation/mobility-data-specification/blob/master/ReleaseGuidelines.md#making-a-release).
This pull request will be merged by an OMF maintainer after OMF Board Approval following the [Release Guidelines](https://github.com/openmobilityfoundation/governance/blob/main/technical/ReleaseGuidelines.md#making-a-release).
4 changes: 2 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE/release-final.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ assignees: jfh01

The Release Candidate for MDS `X.Y.Z` has been approved: <https://github.com/openmobilityfoundation/mobility-data-specification/releases/tag/X.Y.Z-rc>

This pull request will make the release official in `master`.
This pull request will make the release official in `main`.

### Action Item

Merge this pull request following the [Release Guidelines](https://github.com/openmobilityfoundation/mobility-data-specification/blob/master/ReleaseGuidelines.md#making-a-release).
Merge this pull request following the [Release Guidelines](https://github.com/openmobilityfoundation/governance/blob/main/technical/ReleaseGuidelines.md#making-a-release).
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Code of Conduct

Particpation with the OMF is governed by the OMF's [Code of Conduct](https://github.com/openmobilityfoundation/governance/blob/master/CODE_OF_CONDUCT.md) and [Participation Policies](https://github.com/openmobilityfoundation/governance/raw/master/documents/OMFParticipationPolicies.pdf).
Particpation with the OMF is governed by the OMF's [Code of Conduct](https://github.com/openmobilityfoundation/governance/blob/main/CODE_OF_CONDUCT.md) and [Participation Policies](https://github.com/openmobilityfoundation/governance/raw/main/documents/OMFParticipationPolicies.pdf).
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# MDS Contributor Guidelines

**See the new [MDS Contributor Guidelines](https://github.com/openmobilityfoundation/governance/blob/master/CONTRIBUTING.md) document for details.**
**See the new [MDS Contributor Guidelines](https://github.com/openmobilityfoundation/governance/blob/main/CONTRIBUTING.md) document for details.**
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ You can read more about the different APIs here: **[Understanding the different
## Learn More / Get Involved / Contributing
To stay up to date on MDS releases, meetings, and events, please **subscribe to the [mds-announce](https://groups.google.com/a/groups.openmobilityfoundation.org/forum/#!forum/mds-announce) mailing list.**

The Mobility Data Specification is an open source project with all development taking place on GitHub. Comments and ideas can be shared by [creating an issue](https://github.com/openmobilityfoundation/mobility-data-specification/issues), and specific changes can be suggested by [opening a pull request](https://github.com/openmobilityfoundation/mobility-data-specification/pulls). Before contributing, please review our OMF [CONTRIBUTING page](https://github.com/openmobilityfoundation/governance/blob/master/CONTRIBUTING.md) to understand guidelines and policies for participation and our [CODE OF CONDUCT page](https://github.com/openmobilityfoundation/governance/blob/master/CODE_OF_CONDUCT.md).
The Mobility Data Specification is an open source project with all development taking place on GitHub. Comments and ideas can be shared by [creating an issue](https://github.com/openmobilityfoundation/mobility-data-specification/issues), and specific changes can be suggested by [opening a pull request](https://github.com/openmobilityfoundation/mobility-data-specification/pulls). Before contributing, please review our OMF [CONTRIBUTING page](https://github.com/openmobilityfoundation/governance/blob/main/CONTRIBUTING.md) to understand guidelines and policies for participation and our [CODE OF CONDUCT page](https://github.com/openmobilityfoundation/governance/blob/main/CODE_OF_CONDUCT.md).

You can learn more about the polices, methodolgies, and tools in the MDS ecosystem in the [Mobility Data Management State of Practice](https://github.com/openmobilityfoundation/privacy-committee/wiki/Mobility-Data-Management-State-of-Practice) wiki.

Expand All @@ -39,11 +39,11 @@ For questions about MDS please contact [[email protected]](mailto:

## Versions

The specification will be versioned using Git tags and [semantic versioning](https://semver.org/). See prior [releases](https://github.com/openmobilityfoundation/mobility-data-specification/releases) and the [Release Guidelines](https://github.com/openmobilityfoundation/governance/blob/master/technical/ReleaseGuidelines.md) for more information.
The specification will be versioned using Git tags and [semantic versioning](https://semver.org/). See prior [releases](https://github.com/openmobilityfoundation/mobility-data-specification/releases) and the [Release Guidelines](https://github.com/openmobilityfoundation/governance/blob/main/technical/ReleaseGuidelines.md) for more information.

Information about the latest release and all releases are below. Please note, you may be viewing a development copy of the Mobility Data Specification based on the current branch. Info about the latest release and all releases is below.

* [Latest Release](https://github.com/openmobilityfoundation/mobility-data-specification/tree/master)
* [Latest Release](https://github.com/openmobilityfoundation/mobility-data-specification/tree/main)

* [All Releases](https://github.com/openmobilityfoundation/mobility-data-specification/releases)

Expand Down
2 changes: 1 addition & 1 deletion ReleaseGuidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

MDS will see regular updates and new [releases](https://github.com/openmobilityfoundation/mobility-data-specification/releases).

**See the new [MDS Release Guidelines](https://github.com/openmobilityfoundation/governance/blob/master/technical/ReleaseGuidelines.md) document for details.**
**See the new [MDS Release Guidelines](https://github.com/openmobilityfoundation/governance/blob/main/technical/ReleaseGuidelines.md) document for details.**

2 changes: 1 addition & 1 deletion ReleaseNotes.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,4 +198,4 @@ This release includes a number of enhancements and clarifications to the [`provi

* MDS is under active development. As such, pre-`1.0` versions may introduce breaking changes until things stabilize. Every effort will be made to ensure that any breaking change is well documented and that appropriate workarounds are suggested.

[provider]: https://github.com/openmobilityfoundation/mobility-data-specification/tree/master/provider
[provider]: https://github.com/openmobilityfoundation/mobility-data-specification/tree/main/provider
4 changes: 2 additions & 2 deletions agency/get_vehicle.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"$id": "https://raw.githubusercontent.com/openmobilityfoundation/mobility-data-specification/master/agency/get_vehicle.json",
"$id": "https://raw.githubusercontent.com/openmobilityfoundation/mobility-data-specification/main/agency/get_vehicle.json",
"$schema": "http://json-schema.org/draft-06/schema#",
"title": "The MDS Agency Schema, GET vehicle payload",
"type": "object",
Expand Down Expand Up @@ -300,4 +300,4 @@
}
},
"additionalProperties": false
}
}
4 changes: 2 additions & 2 deletions agency/post_vehicle.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"$id": "https://raw.githubusercontent.com/openmobilityfoundation/mobility-data-specification/master/agency/post_vehicle.json",
"$id": "https://raw.githubusercontent.com/openmobilityfoundation/mobility-data-specification/main/agency/post_vehicle.json",
"$schema": "http://json-schema.org/draft-06/schema#",
"title": "The MDS Agency Schema, register vehicle body",
"type": "object",
Expand Down Expand Up @@ -107,4 +107,4 @@
}
},
"additionalProperties": false
}
}
4 changes: 2 additions & 2 deletions agency/post_vehicle_event.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"$id": "https://raw.githubusercontent.com/openmobilityfoundation/mobility-data-specification/master/agency/post_vehicle_event.json",
"$id": "https://raw.githubusercontent.com/openmobilityfoundation/mobility-data-specification/main/agency/post_vehicle_event.json",
"$schema": "http://json-schema.org/draft-06/schema#",
"title": "The MDS Agency Schema, POST vehicle status body",
"type": "object",
Expand Down Expand Up @@ -248,4 +248,4 @@
}
},
"additionalProperties": false
}
}
4 changes: 2 additions & 2 deletions agency/post_vehicle_telemetry.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"$id": "https://raw.githubusercontent.com/openmobilityfoundation/mobility-data-specification/master/agency/post_vehicle_telemetry.json",
"$id": "https://raw.githubusercontent.com/openmobilityfoundation/mobility-data-specification/main/agency/post_vehicle_telemetry.json",
"$schema": "http://json-schema.org/draft-06/schema#",
"title": "The MDS Agency Schema, POST vehicle telemetry body",
"type": "object",
Expand Down Expand Up @@ -88,4 +88,4 @@
}
},
"additionalProperties": false
}
}
2 changes: 1 addition & 1 deletion provider/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -356,7 +356,7 @@ Without an `event_time` query parameter, `/status_changes` shall return a `400 B

All MDS compatible `provider` APIs must expose a public [GBFS](https://github.com/NABSA/gbfs) feed as well. Compatibility with [GBFS 2.0](https://github.com/NABSA/gbfs/blob/v2.0/gbfs.md) or greater is advised due to privacy concerns and support for micromobility.

GBFS 2.0 includes some changes that may make it less useful for regulatory purposes (specifically, the automatic rotation of vehicle IDs). The [`/vehicles`](#vehicles) endpoint offers an alternative to GBFS that may more effectively meet the use cases of regulators. Additional information on MDS and GBFS can be found in this [guidance document](https://github.com/openmobilityfoundation/governance/blob/master/technical/GBFS_and_MDS.md).
GBFS 2.0 includes some changes that may make it less useful for regulatory purposes (specifically, the automatic rotation of vehicle IDs). The [`/vehicles`](#vehicles) endpoint offers an alternative to GBFS that may more effectively meet the use cases of regulators. Additional information on MDS and GBFS can be found in this [guidance document](https://github.com/openmobilityfoundation/governance/blob/main/technical/GBFS_and_MDS.md).

### Events

Expand Down
2 changes: 1 addition & 1 deletion provider/auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ If an MDS `provider` implements this auth scheme, it **MAY** choose to specify t

The `/trips` and `/status_changes` endpoints may or may not require authentication, it is up to the implementing provider to decide if they want historical information available with or without authentication.

As of MDS 0.3.0, `gbfs.json` is required. The required GBFS endpoints should be made available publicly. See [#realtime-data](https://github.com/openmobilityfoundation/mobility-data-specification/tree/master/provider#realtime-data) for more information about how to implement GBFS for dockless systems.
As of MDS 0.3.0, `gbfs.json` is required. The required GBFS endpoints should be made available publicly. See [#realtime-data](https://github.com/openmobilityfoundation/mobility-data-specification/tree/main/provider#realtime-data) for more information about how to implement GBFS for dockless systems.
4 changes: 2 additions & 2 deletions provider/dockless/events.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"$id": "https://raw.githubusercontent.com/openmobilityfoundation/mobility-data-specification/master/provider/dockless/events.json",
"$id": "https://raw.githubusercontent.com/openmobilityfoundation/mobility-data-specification/main/provider/dockless/events.json",
"$schema": "http://json-schema.org/draft-06/schema#",
"title": "The MDS Provider Schema, events payload",
"type": "object",
Expand Down Expand Up @@ -291,4 +291,4 @@
}
},
"additionalProperties": false
}
}
4 changes: 2 additions & 2 deletions provider/dockless/status_changes.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"$id": "https://raw.githubusercontent.com/openmobilityfoundation/mobility-data-specification/master/provider/dockless/status_changes.json",
"$id": "https://raw.githubusercontent.com/openmobilityfoundation/mobility-data-specification/main/provider/dockless/status_changes.json",
"$schema": "http://json-schema.org/draft-06/schema#",
"title": "The MDS Provider Schema, status_change payload",
"type": "object",
Expand Down Expand Up @@ -419,4 +419,4 @@
}
},
"additionalProperties": false
}
}
4 changes: 2 additions & 2 deletions provider/dockless/trips.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"$id": "https://raw.githubusercontent.com/openmobilityfoundation/mobility-data-specification/master/provider/dockless/trips.json",
"$id": "https://raw.githubusercontent.com/openmobilityfoundation/mobility-data-specification/main/provider/dockless/trips.json",
"$schema": "http://json-schema.org/draft-06/schema#",
"title": "The MDS Provider Schema, trips payload",
"type": "object",
Expand Down Expand Up @@ -413,4 +413,4 @@
}
},
"additionalProperties": false
}
}
4 changes: 2 additions & 2 deletions provider/dockless/vehicles.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"$id": "https://raw.githubusercontent.com/openmobilityfoundation/mobility-data-specification/master/provider/dockless/vehicles.json",
"$id": "https://raw.githubusercontent.com/openmobilityfoundation/mobility-data-specification/main/provider/dockless/vehicles.json",
"$schema": "http://json-schema.org/draft-06/schema#",
"title": "The MDS Provider Schema, vehicles payload",
"type": "object",
Expand Down Expand Up @@ -384,4 +384,4 @@
}
},
"additionalProperties": false
}
}
2 changes: 1 addition & 1 deletion schema/templates/agency/get_vehicle.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"$id": "https://raw.githubusercontent.com/openmobilityfoundation/mobility-data-specification/master/agency/get_vehicle.json",
"$id": "https://raw.githubusercontent.com/openmobilityfoundation/mobility-data-specification/main/agency/get_vehicle.json",
"$schema": "http://json-schema.org/draft-06/schema#",
"title": "The MDS Agency Schema, GET vehicle payload",
"type": "object",
Expand Down
2 changes: 1 addition & 1 deletion schema/templates/agency/post_vehicle.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"$id": "https://raw.githubusercontent.com/openmobilityfoundation/mobility-data-specification/master/agency/post_vehicle.json",
"$id": "https://raw.githubusercontent.com/openmobilityfoundation/mobility-data-specification/main/agency/post_vehicle.json",
"$schema": "http://json-schema.org/draft-06/schema#",
"title": "The MDS Agency Schema, register vehicle body",
"type": "object",
Expand Down
2 changes: 1 addition & 1 deletion schema/templates/agency/post_vehicle_event.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"$id": "https://raw.githubusercontent.com/openmobilityfoundation/mobility-data-specification/master/agency/post_vehicle_event.json",
"$id": "https://raw.githubusercontent.com/openmobilityfoundation/mobility-data-specification/main/agency/post_vehicle_event.json",
"$schema": "http://json-schema.org/draft-06/schema#",
"title": "The MDS Agency Schema, POST vehicle status body",
"type": "object",
Expand Down
2 changes: 1 addition & 1 deletion schema/templates/agency/post_vehicle_telemetry.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"$id": "https://raw.githubusercontent.com/openmobilityfoundation/mobility-data-specification/master/agency/post_vehicle_telemetry.json",
"$id": "https://raw.githubusercontent.com/openmobilityfoundation/mobility-data-specification/main/agency/post_vehicle_telemetry.json",
"$schema": "http://json-schema.org/draft-06/schema#",
"title": "The MDS Agency Schema, POST vehicle telemetry body",
"type": "object",
Expand Down
2 changes: 1 addition & 1 deletion schema/templates/common.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"$id": "https://raw.githubusercontent.com/openmobilityfoundation/mobility-data-specification/master/schema/templates/common.json",
"$id": "https://raw.githubusercontent.com/openmobilityfoundation/mobility-data-specification/main/schema/templates/common.json",
"$schema": "http://json-schema.org/draft-06/schema#",
"title": "The MDS Provider Schema, common definitions",
"type": "object",
Expand Down
2 changes: 1 addition & 1 deletion schema/templates/provider/status_changes.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"$id": "https://raw.githubusercontent.com/openmobilityfoundation/mobility-data-specification/master/provider/dockless/status_changes.json",
"$id": "https://raw.githubusercontent.com/openmobilityfoundation/mobility-data-specification/main/provider/dockless/status_changes.json",
"$schema": "http://json-schema.org/draft-06/schema#",
"title": "The MDS Provider Schema, status_change payload",
"type": "object",
Expand Down
2 changes: 1 addition & 1 deletion schema/templates/provider/trips.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"$id": "https://raw.githubusercontent.com/openmobilityfoundation/mobility-data-specification/master/provider/dockless/trips.json",
"$id": "https://raw.githubusercontent.com/openmobilityfoundation/mobility-data-specification/main/provider/dockless/trips.json",
"$schema": "http://json-schema.org/draft-06/schema#",
"title": "The MDS Provider Schema, trips payload",
"type": "object",
Expand Down
2 changes: 1 addition & 1 deletion schema/templates/provider/vehicles.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"$id": "https://raw.githubusercontent.com/openmobilityfoundation/mobility-data-specification/master/provider/dockless/vehicles.json",
"$id": "https://raw.githubusercontent.com/openmobilityfoundation/mobility-data-specification/main/provider/dockless/vehicles.json",
"$schema": "http://json-schema.org/draft-06/schema#",
"title": "The MDS Provider Schema, vehicles payload",
"type": "object",
Expand Down