Skip to content

Commit 3006d8a

Browse files
committed
Link and TOC fixes
1 parent d2fb262 commit 3006d8a

3 files changed

Lines changed: 18 additions & 15 deletions

File tree

agency/README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,9 @@ See the [GBFS Requirement](/README.md#gbfs-requirement) language for more detail
7070

7171
The `/vehicles` endpoint returns the specified vehicle (if a device_id is provided) or a list of known vehicles. Providers can only retrieve data for vehicles in their registered fleet. Contains vehicle properties that do not change often.
7272

73-
Endpoint: `/vehicles/{device_id}`
74-
Method: `GET`
73+
**Endpoint**: `/vehicles/{device_id}`
74+
**Method:** `POST`
75+
**Payload:** An array of [Vehicles](/data-types.md#vehicles)
7576

7677
Path Params:
7778

@@ -105,8 +106,9 @@ _No content returned on vehicle not found._
105106

106107
The `/vehicles/status` endpoint returns information about the specified vehicle (if a device_id is provided) or a list of known vehicles current state. Providers can only retrieve data for vehicles in their registered fleet. Contains specific vehicle properties that are updated frequently.
107108

108-
Endpoint: `/vehicles/status/{device_id}`
109-
Method: `GET`
109+
**Endpoint**: `/vehicles/status/{device_id}`
110+
**Method:** `POST`
111+
**Payload:** An array of [Vehicles](/data-types.md#vehicle-status) objects
110112

111113
Path Params:
112114

@@ -214,7 +216,7 @@ The vehicle `/telemetry` endpoint allows a Provider to send vehicle telemetry da
214216

215217
**Endpoint**: `/telemetry`
216218
**Method**: `POST`
217-
**Payload**: An array of [Vehicle Telemetry][vehicle-telemetry]
219+
**Payload**: An array of vehicle [Telemetry][vehicle-telemetry]
218220

219221
200 Success Response:
220222

data-types.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This MDS data types page catalogs the objects (fields, types, requirements, desc
77
- [Vehicles](#vehicles)
88
- [Vehicle Types](#vehicle-types)
99
- [Propulsion Types](#propulsion-types)
10-
- [Vehicle Status](#vehicle-status)
10+
- [Vehicle Status](#vehicle-status)
1111
- [Events](#events)
1212
- [Event Types](#event-times)
1313
- [Telemetry](#telemetry)
@@ -65,7 +65,7 @@ A vehicle may have one or more values from the `propulsion`, depending on the nu
6565

6666
[Top][toc]
6767

68-
## Vehicle Status
68+
### Vehicle Status
6969

7070
A vehicle status record represents the current or last-known event and telemetry from a vehicle, defined as follows:
7171

@@ -113,7 +113,7 @@ A standard point of vehicle telemetry. References to latitude and longitude impl
113113

114114
| Field | Type | Required/Optional | Field Description |
115115
| ----- | ---- | ----------------- | ----------------- |
116-
| `device_id` | UUID | Required | ID used in [Register](#vehicle---register) |
116+
| `device_id` | UUID | Required | A unique device ID in UUID format |
117117
| `provider_id` | UUID | Required | A UUID for the Provider, unique within MDS. See MDS [provider list](/providers.csv). |
118118
| `data_provider_id`| UUID | Optional | If different than `provider_id`, a UUID for the data solution provider managing the data feed in this endpoint. See MDS [provider list](/providers.csv) which includes both service operators and data solution providers. |
119119
| `telemetry_id` | UUID | Required | ID used for uniquely-identifying a Telemetry entry |

provider/README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -221,8 +221,8 @@ The `/vehicles/status` endpoint returns the specified vehicle (if a device_id is
221221
**Endpoint:** `/vehicles/status/{device_id}`
222222
**Method:** `GET`
223223
**[Beta feature][beta]:** No (as of 1.2.0)
224-
**Schema:** [`vehicles-status` schema][vehicles-status-schema]
225-
**`data` Payload:** `{ "vehicles": [] }`, an array of [Vehicle Status](vehicle-status) objects
224+
**Schema:** N/A
225+
**`data` Payload:** `{ "vehicles": [] }`, an array of [Vehicle Status][vehicle-status] objects
226226

227227
Path Params:
228228

@@ -325,7 +325,7 @@ Unless stated otherwise by the municipality, this endpoint must return only thos
325325
**Endpoint:** `/telemetry`
326326
**Method:** `GET`
327327
**Schema:** [`telemetry` schema][telemetry-schema]
328-
**`data` Payload:** `{ "telemetry": [] }`, an array of `telemetry` objects
328+
**`data` Payload:** `{ "telemetry": [] }`, an array of [Vehicle Telemetry][vehicle-telemetry] objects
329329

330330
[Top][toc]
331331

@@ -345,13 +345,13 @@ The `/events/recent` and `/events/historical/` endpoints return a list of Event
345345

346346
Unless stated otherwise by the municipality, this endpoint must return only those status changes with a `event_location` that [intersects](#intersection-operation) with the [municipality boundary](#municipality-boundary).
347347

348-
> Note: As a result of this definition, consumers should query the [trips endpoint][trips] to infer when vehicles enter or leave the municipality boundary.
348+
> Note: As a result of this definition, consumers should query the [trips endpoint](#trips) to infer when vehicles enter or leave the municipality boundary.
349349

350350
**Endpoint:** `/events/historical`
351351
**Method:** `GET`
352352
**[Beta feature][beta]:** No
353353
**Schema:** [`events` schema][events-schema]
354-
**`data` Payload:** `{ "data": [] }`, an array of [Vehicle Event Data](#vehicle-event-data)
354+
**`data` Payload:** `{ "data": [] }`, an array of [Events](/data-types.md#events) object
355355

356356
[Top][toc]
357357

@@ -402,7 +402,7 @@ See also [Stop-based Geographic Data][stop-based-geo].
402402
**Method:** `GET`
403403
**[Beta feature][beta]:** No (as of 1.0.0)
404404
**Schema:** [`events` schema][events-schema]
405-
**`data` Payload:** `{ "events": [] }`, an array of Event objects
405+
**`data` Payload:** `{ "events": [] }`, an array of [Events](/data-types.md#events) object objects
406406

407407
#### Recent Events - Query Parameters
408408

@@ -493,7 +493,7 @@ See [Provider examples](examples.md#reports).
493493
[json-schema]: https://json-schema.org
494494
[muni-boundary]: #municipality-boundary
495495
[mode]: /modes/README.md
496-
[point-geo]: /general-information.md#geographic-telemetry-data
496+
[point-geo]: /data-types.md#gps-data
497497
[propulsion-types]: /general-information.md#propulsion-types
498498
[responses]: /general-information.md#responses
499499
[stops]: /data-types.md#stops
@@ -515,4 +515,5 @@ See [Provider examples](examples.md#reports).
515515
[vehicle-events]: /modes#event-types
516516
[vehicle-event-data]: /general-information.md#event-data
517517
[vehicles-schema]: vehicles.json
518+
[vehicle-telemetry]: /data-types.md#telemetry
518519
[versioning]: /general-information.md#versioning

0 commit comments

Comments
 (0)