Skip to content

Commit 7f02c56

Browse files
committed
feat(analytics): move offset and limit documentation to analytics to add details about pagination limit
1 parent 18c1249 commit 7f02c56

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

specs/analytics/common/parameters.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,34 @@ OrderBy:
1919
schema:
2020
$ref: '#/orderBy'
2121

22+
Offset:
23+
in: query
24+
name: offset
25+
description: |
26+
Position of the first item to return.
27+
28+
Combined with the `limit` parameter, only the first 1000 items can be retrieved.
29+
required: false
30+
schema:
31+
type: integer
32+
default: 0
33+
minimum: 0
34+
maximum: 1000
35+
36+
Limit:
37+
in: query
38+
name: limit
39+
description: |
40+
Number of items to return.
41+
42+
Combined with the `offset` parameter, only the first 1000 items can be retrieved.
43+
44+
required: false
45+
schema:
46+
type: integer
47+
default: 10
48+
maximum: 1000
49+
2250
# private
2351
orderBy:
2452
type: string

0 commit comments

Comments
 (0)