File tree 1 file changed +24
-3
lines changed
1 file changed +24
-3
lines changed Original file line number Diff line number Diff line change @@ -56,14 +56,19 @@ key | type | value | description | required
56
56
Pagination tokens are positions between events. This already an established
57
57
concept but to illustrate this better, see the following diagram:
58
58
```
59
- pagination_token
60
- |
61
- <oldest-in-time> [0]<--[1] <gap> [gap_start_event_id]▼ <--[4]<--[5]<--[6] <newest-in-time>
59
+ pagination_token
60
+ |
61
+ <oldest-in-time> [0]<--[1]<-- <gap>▼ <--[4 (next_to_event_id) ]<--[5]<--[6] <newest-in-time>
62
62
```
63
63
64
+ The idea is to be able to keep paginating from ` pagination_token ` in the same
65
+ direction of the request to fill in the gap.
66
+
64
67
65
68
### ` /messages ` response examples
66
69
70
+ #### ` /messages?dir=f `
71
+
67
72
` /messages?dir=f ` response example with a gap (` chunk ` has events in
68
73
chronoligcal order):
69
74
@@ -95,6 +100,15 @@ chronoligcal order):
95
100
}
96
101
```
97
102
103
+ ```
104
+ pagination_token
105
+ |
106
+ <oldest-in-time> [foo (next_to_event_id)]<-- ▼<gap> <--[baz] <newest-in-time>
107
+ ```
108
+
109
+
110
+ #### ` /messages?dir=b `
111
+
98
112
99
113
` /messages?dir=b ` response example with a gap (` chunk ` has events in
100
114
reverse-chronoligcal order):
@@ -127,6 +141,13 @@ reverse-chronoligcal order):
127
141
}
128
142
```
129
143
144
+ ```
145
+ pagination_token
146
+ |
147
+ <oldest-in-time> [foo]<-- <gap>▼ <--[baz (next_to_event_id)] <newest-in-time>
148
+ ```
149
+
150
+
130
151
131
152
## Potential issues
132
153
You can’t perform that action at this time.
0 commit comments