ARUHA-1442 Add documentation about batch_flush_timeout

zalando · Jan 12, 2018 · 0ddb7ed · 0ddb7ed
1 parent 124a3fe
commit 0ddb7ed
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/docs/_data/nakadi-event-bus-api.yaml b/docs/_data/nakadi-event-bus-api.yaml
@@ -2667,6 +2667,8 @@ parameters:
       is reached, the messages are immediately flushed to the client and batch flush timer is reset.
 
       * If 0 or undefined, will assume 30 seconds.
+
+      * Value is treated as a recommendation. Nakadi may flush chunks with a smaller timeout.
     type: number
     format: int32
     required: false