Skip to content

Commit 29c7a76

Browse files
committed
Update documentation for count parameter
1 parent 494a1e5 commit 29c7a76

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

api/simplyrets-openapi.yaml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1801,17 +1801,18 @@ components:
18011801
in: query
18021802
name: count
18031803
description: |
1804-
When set to `false`, The `X-Total-Count` header will not
1805-
be returned
1804+
When set to `true`, The `X-Total-Count` header will be
1805+
returned, showing the total number of items matching the query.
18061806
18071807
Counting the listings can contribute to slower API calls
18081808
due to the extra queries that need to be run to get an
18091809
exact count.
18101810
1811-
Disabling count can increase query speeds.
1811+
Enabling count may decrease API response/page load times,
1812+
especially on larger datasets.
18121813
schema:
18131814
type: boolean
1814-
default: true
1815+
default: false
18151816
agentQ:
18161817
required: false
18171818
in: query

0 commit comments

Comments
 (0)