Skip to content

Commit 101f135

Browse files
authored
Merge pull request #880 from populus-ai/remove-data-key-from-provider-response-docs
Remove word "data" from provider response payload descriptions
2 parents 93aab20 + 5f3c43f commit 101f135

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

provider/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ The `/vehicles` endpoint returns the specified vehicle (if a device_id is provid
189189
**Method:** `GET`
190190
**[Beta feature][beta]:** No (as of 1.2.0)
191191
**Schema:** See [`mds-openapi`](https://github.com/openmobilityfoundation/mds-openapi) repository for schema.
192-
**`data` Payload:** `{ "vehicles": [] }`, an array of [Vehicle][vehicles] objects
192+
**Payload:** `{ "vehicles": [] }`, an array of [Vehicle][vehicles] objects
193193

194194
_Path Parameters:_
195195

@@ -234,7 +234,7 @@ The `/vehicles/status` endpoint returns the specified vehicle (if a device_id is
234234
**Method:** `GET`
235235
**[Beta feature][beta]:** No (as of 1.2.0)
236236
**Schema:** See [`mds-openapi`](https://github.com/openmobilityfoundation/mds-openapi) repository for schema.
237-
**`data` Payload:** `{ "vehicles_status": [] }`, an array of [Vehicle Status][vehicle-status] objects
237+
**Payload:** `{ "vehicles_status": [] }`, an array of [Vehicle Status][vehicle-status] objects
238238

239239
_Path Parameters:_
240240

@@ -283,7 +283,7 @@ Unless stated otherwise by the municipality, the trips endpoint must return all
283283
**Method:** `GET`
284284
**[Beta feature][beta]:** No
285285
**Schema:** See [`mds-openapi`](https://github.com/openmobilityfoundation/mds-openapi) repository for schema.
286-
**`data` Payload:** `{ "trips": [] }`, an array of [Trip][trips] objects
286+
**Payload:** `{ "trips": [] }`, an array of [Trip][trips] objects
287287

288288
### Trips - Query Parameters
289289

@@ -348,7 +348,7 @@ Telemetry for a [trip](#trip) must include at least 2 points: the start point an
348348
**Endpoint:** `/telemetry`
349349
**Method:** `GET`
350350
**Schema:** See [`mds-openapi`](https://github.com/openmobilityfoundation/mds-openapi) repository for schema.
351-
**`data` Payload:** `{ "telemetry": [] }`, an array of [Vehicle Telemetry][vehicle-telemetry] objects
351+
**Payload:** `{ "telemetry": [] }`, an array of [Vehicle Telemetry][vehicle-telemetry] objects
352352

353353
[Top][toc]
354354

@@ -385,7 +385,7 @@ Unless stated otherwise by the municipality, this endpoint must return only thos
385385
**Method:** `GET`
386386
**[Beta feature][beta]:** No
387387
**Schema:** See [`mds-openapi`](https://github.com/openmobilityfoundation/mds-openapi) repository for schema.
388-
**`data` Payload:** `{ "events": [] }`, an array of [Events](/data-types.md#events) object
388+
**Payload:** `{ "events": [] }`, an array of [Events](/data-types.md#events) object
389389

390390
[Top][toc]
391391

@@ -447,7 +447,7 @@ See also [Stop-based Geographic Data][stop-based-geo].
447447
**Method:** `GET`
448448
**[Beta feature][beta]:** No (as of 1.0.0)
449449
**Schema:** See [`mds-openapi`](https://github.com/openmobilityfoundation/mds-openapi) repository for schema.
450-
**`data` Payload:** `{ "events": [] }`, an array of [Events](/data-types.md#events) object objects
450+
**Payload:** `{ "events": [] }`, an array of [Events](/data-types.md#events) object objects
451451

452452
#### Recent Events - Query Parameters
453453

@@ -494,7 +494,7 @@ In addition to the standard [Provider payload wrapper](#response-format), respon
494494
**Method:** `GET`
495495
**[Beta feature][beta]:** Yes (as of 1.0.0). [Leave feedback](https://github.com/openmobilityfoundation/mobility-data-specification/issues/638)
496496
**Schema:** See [`mds-openapi`](https://github.com/openmobilityfoundation/mds-openapi) repository for schema.
497-
**`data` Payload:** `{ "stops": [] }`, an array of [Stops][stops]
497+
**Payload:** `{ "stops": [] }`, an array of [Stops][stops]
498498

499499
In the case that a `stop_id` path parameter is specified, the `stops` array returned will only have one entry. In the case that no `stop_id` query parameter is specified, all stops will be returned.
500500

@@ -527,8 +527,8 @@ The authenticated reports are monthly, historic flat files that may be pre-gener
527527
**[Beta feature][beta]:** No (as of 2.0.0). [Leave feedback](https://github.com/openmobilityfoundation/mobility-data-specification/issues/672)
528528
**Usage note:** This endpoint uses media-type `text/vnd.mds+csv` instead of `application/vnd.mds+json`, see [Versioning][versioning].
529529
**Schema:** See [`mds-openapi`](https://github.com/openmobilityfoundation/mds-openapi) repository for schema.
530-
**`data` Filename:** monthly file named by year and month, e.g. `/reports/YYYY-MM.csv`
531-
**`data` Payload:** monthly CSV files of [Report](/data-types.md#Reports) objects
530+
**Filename:** monthly file named by year and month, e.g. `/reports/YYYY-MM.csv`
531+
**Payload:** monthly CSV files of [Report](/data-types.md#Reports) objects
532532

533533
#### Responses
534534

0 commit comments

Comments
 (0)