Skip to content

Commit 06d2536

Browse files
committed
Vehicle status text updates
1 parent 3006d8a commit 06d2536

2 files changed

Lines changed: 5 additions & 5 deletions

File tree

agency/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,11 +118,11 @@ Path Params:
118118

119119
200 Success Response:
120120

121-
If `device_id` is specified, `GET` will return an array with a single vehicle record, otherwise it will be a list of vehicle records with pagination details per the [JSON API](https://jsonapi.org/format/#fetching-pagination) spec:
121+
If `device_id` is specified, `GET` will return an array with a vehicle status record, otherwise it will be a list of vehicle records with pagination details per the [JSON API](https://jsonapi.org/format/#fetching-pagination) spec:
122122

123123
```json
124124
{
125-
"vehicles": [ ... ]
125+
"vehicles_status": [ ... ]
126126
"links": {
127127
"first": "https://...",
128128
"last": "https://...",

provider/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -216,13 +216,13 @@ _No content returned on vehicle not found._
216216

217217
### Vehicle Status
218218

219-
The `/vehicles/status` endpoint returns the specified vehicle (if a device_id is provided) or a list of known vehicles. Contains specific vehicle properties that are updated frequently.
219+
The `/vehicles/status` endpoint returns the specified vehicle (if a device_id is provided) or a list of known vehicles. Contains specific vehicle status records that are updated frequently.
220220

221221
**Endpoint:** `/vehicles/status/{device_id}`
222222
**Method:** `GET`
223223
**[Beta feature][beta]:** No (as of 1.2.0)
224224
**Schema:** N/A
225-
**`data` Payload:** `{ "vehicles": [] }`, an array of [Vehicle Status][vehicle-status] objects
225+
**`data` Payload:** `{ "vehicles_status": [] }`, an array of [Vehicle Status][vehicle-status] objects
226226

227227
Path Params:
228228

@@ -232,7 +232,7 @@ Path Params:
232232

233233
200 Success Response:
234234

235-
If `device_id` is specified, `GET` will return an array with a single vehicle record, otherwise it will be a list of vehicle records with pagination details per the [JSON API](https://jsonapi.org/format/#fetching-pagination) spec:
235+
If `device_id` is specified, `GET` will return an array with a vehicle status record, otherwise it will be a list of vehicle records with pagination details per the [JSON API](https://jsonapi.org/format/#fetching-pagination) spec:
236236

237237
```json
238238
{

0 commit comments

Comments
 (0)