Skip to content

Commit 3334b27

Browse files
committed
making required/optional endpoints more explicit
1 parent 1844cff commit 3334b27

1 file changed

Lines changed: 15 additions & 12 deletions

File tree

provider/README.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -200,10 +200,11 @@ The trips endpoint allows a user to query historical trip data.
200200

201201
Unless stated otherwise by the municipality, the trips endpoint must return all trips with a `route` which [intersects](#intersection-operation) with the [municipality boundary](#municipality-boundary).
202202

203-
Endpoint: `/trips`
204-
Method: `GET`
205-
Schema: [`trips` schema][trips-schema]
206-
`data` Payload: `{ "trips": [] }`, an array of objects with the following structure
203+
**Endpoint:** `/trips`
204+
**Method:** `GET`
205+
**Required/Optional:** Required
206+
**Schema:** [`trips` schema][trips-schema]
207+
**`data` Payload:** `{ "trips": [] }`, an array of objects with the following structure
207208

208209
| Field | Type | Required/Optional | Comments |
209210
| ----- | -------- | ----------------- | ----- |
@@ -290,10 +291,11 @@ Unless stated otherwise by the municipality, this endpoint must return only thos
290291

291292
> Note: As a result of this definition, consumers should query the [trips endpoint](#trips) to infer when vehicles enter or leave the municipality boundary.
292293
293-
Endpoint: `/status_changes`
294-
Method: `GET`
295-
Schema: [`status_changes` schema][sc-schema]
296-
`data` Payload: `{ "status_changes": [] }`, an array of objects with the following structure
294+
**Endpoint:** `/status_changes`
295+
**Method:** `GET`
296+
**Required/Optional:** Required
297+
**Schema:** [`status_changes` schema][sc-schema]
298+
**`data` Payload:** `{ "status_changes": [] }`, an array of objects with the following structure
297299

298300
| Field | Type | Required/Optional | Comments |
299301
| ----- | ---- | ----------------- | ----- |
@@ -370,10 +372,11 @@ Unless stated otherwise by the municipality, this endpoint must return only thos
370372
371373
The schema and datatypes are the same as those defined for [`/status_changes`][status].
372374

373-
Endpoint: `/events`
374-
Method: `GET`
375-
Schema: [`status_changes` schema][sc-schema]
376-
`data` Payload: `{ "status_changes": [] }`, an array of objects with the same structure as in [`/status_changes`][status]
375+
**Endpoint:** `/events`
376+
**Method:** `GET`
377+
**Required/Optional:** Optional starting with `0.4.0`, moving to Required in a future version (`0.5.0`+)
378+
**Schema:** [`status_changes` schema][sc-schema]
379+
**`data` Payload:** `{ "status_changes": [] }`, an array of objects with the same structure as in [`/status_changes`][status]
377380

378381
#### Event Times
379382

0 commit comments

Comments
 (0)