Skip to content

Commit

Permalink
Clarify cursor positioning
Browse files Browse the repository at this point in the history
  • Loading branch information
dehora committed Jun 22, 2016
1 parent 03b1acc commit 72c8c89
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/api-spec-oai/nakadi-oai-0.6.0.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -399,9 +399,10 @@ paths:
The event stream is formatted as a sequence of `EventStreamBatch`es separated by `\n`. Each
`EventStreamBatch` contains a chunk of Events and a `Cursor` pointing to the **end** of the
chunk (i.e. last delivered Event). The cursor might specify the offset with the symbolic
value `BEGIN`, which will open the stream starting from the oldest available offset in the
partition.
chunk (i.e. last delivered Event). The default cursor position is at the front of the
stream, with new events that arrive being sent to the client. The cursor's position in the
stream can be specified by sending the value `BEGIN`, which opens the stream starting from
the oldest available offset in the partition.
Currently the `application/x-json-stream` format is the only one supported by the system,
but in the future other media types may be supported.
Expand Down

0 comments on commit 72c8c89

Please sign in to comment.