Skip to content

Commit 8b81d51

Browse files
authored
Merge pull request #44 from SimplyRETS/update-count-parameter
Update documentation for count parameter
2 parents e24642f + 29c7a76 commit 8b81d51

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
@@ -1815,17 +1815,18 @@ components:
18151815
in: query
18161816
name: count
18171817
description: |
1818-
When set to `false`, The `X-Total-Count` header will not
1819-
be returned
1818+
When set to `true`, The `X-Total-Count` header will be
1819+
returned, showing the total number of items matching the query.
18201820
18211821
Counting the listings can contribute to slower API calls
18221822
due to the extra queries that need to be run to get an
18231823
exact count.
18241824
1825-
Disabling count can increase query speeds.
1825+
Enabling count may decrease API response/page load times,
1826+
especially on larger datasets.
18261827
schema:
18271828
type: boolean
1828-
default: true
1829+
default: false
18291830
agentQ:
18301831
required: false
18311832
in: query

0 commit comments

Comments
 (0)