Pagination

Configure pagination for methods that return multiple results:

openrpc.yml
1methods:
2 - name: user.list
3 summary: List users with pagination
4 params:
5 - name: pagination
6 schema:
7 type: object
8 properties:
9 cursor:
10 type: string
11 limit:
12 type: integer
13 default: 20
14 x-fern-pagination:
15 cursor: pagination.cursor
16 results: users
17 next_cursor: pagination.nextCursor
18 has_next_page: pagination.hasMore
19 result:
20 name: userList
21 schema:
22 type: object
23 properties:
24 users:
25 type: array
26 items:
27 $ref: '#/components/schemas/User'
28 pagination:
29 type: object
30 properties:
31 nextCursor:
32 type: string
33 hasMore:
34 type: boolean