Skip to content

Commit 8eb06ae

Browse files
committed
docs: changed epoch to optional; added documentation to note iso8601 option; added note to explain JSON events as either single JSON object or array
1 parent e5c1711 commit 8eb06ae

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

apiary.apib

+4-2
Original file line numberDiff line numberDiff line change
@@ -95,15 +95,17 @@ This is the main endpoint for shipping data to Initial State's Events Api. The d
9595
|`X-IS-BucketKey`|This is a user generated key and can be any string exluding characters `:`, `"`, `'`. See *Bucket Creation* endpoint|
9696

9797
**Event JSON Entity**
98-
> Note: JSON events can be sent as either a single object as the root of the http body, or inside an array of events with the root of the HTTP body being an array `[]`
98+
> **Note**: JSON events can be sent as either a single object as the root of the http body, or inside an array of events with the root of the HTTP body being an array `[]`
9999
100100
|name|required|type|max length|notes|
101101
|----|----|-----|---|---|
102102
|key |*true*|`string`|100 characters|stream key name|
103103
|value |*true*|`string`, `bool`, or `number`|2000 characters|stream value|
104-
|epoch |*false*|`number`||epoch|
104+
|epoch |*false*|`number`||epoch is in seconds with fractional seconds to left of decimal.|
105105
|iso8601|*false*|`string`||ISO-8601 Timestamp|
106106

107+
> **Timestamping**: If the client doesn't provide a timestamp, a server timestamp will be automatically provided. If a client provides a valid "epoch" value, the "epoch" will be used instead. If the "iso8601" value is supplied it will be used instead. It's important to note, that if both a valid "epoch" and "iso8601" are supplied, the "epoch" will be used as the source of truth.
108+
107109
+ Request
108110
+ Headers
109111

0 commit comments

Comments
 (0)