Skip to content

Commit 93aab20

Browse files
authored
Merge pull request #878 from populus-ai/status-changes-to-events
Update "status changes" to "events" in provider
2 parents 33e0b22 + 1586d47 commit 93aab20

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

provider/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -395,7 +395,7 @@ The `/events/historical` API uses the following query parameter:
395395

396396
| Query Parameter | Format | Expected Output |
397397
| --------- | ------ | --------------- |
398-
| `event_time` | `YYYY-MM-DDTHH`, an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended datetime representing an UTC hour between 00 and 23. | All status changes with an event time occurring within the hour. For example, requesting `event_time=2019-10-01T07` returns all status changes where `2019-10-01T07:00:00 <= status_change.event_time < 2019-10-01T08:00:00` UTC. |
398+
| `event_time` | `YYYY-MM-DDTHH`, an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended datetime representing an UTC hour between 00 and 23. | All events with an event time occurring within the hour. For example, requesting `event_time=2019-10-01T07` returns all events where `2019-10-01T07:00:00 <= event.timestamp < 2019-10-01T08:00:00` UTC. |
399399

400400
Without an `event_time` query parameter, `/events` shall return a `400 Bad Request` error.
401401

@@ -411,14 +411,14 @@ processing for that hour:
411411
* For hours that are in the past but for which data is not yet available
412412
the API shall return a `202 Accepted` response.
413413
* For all other hours the API shall return a `200 OK` response with a fully
414-
populated body, even for hours that contain no status changes to report.
415-
If the hour has no status changes to report the response shall contain an
416-
empty array of status changes:
414+
populated body, even for hours that contain no events to report.
415+
If the hour has no events to report the response shall contain an
416+
empty array of events:
417417

418418
```json
419419
{
420420
"version": "x.y.z",
421-
"status_changes": []
421+
"events": []
422422
}
423423
```
424424

0 commit comments

Comments
 (0)