Skip to content

Commit d12e334

Browse files
algolia-botfebeckshortcuts
committed
docs(analytics): constrain pagination only to limit query parameter (generated)
algolia/api-clients-automation#4012 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Fernando Beck <[email protected]> Co-authored-by: shortcuts <[email protected]>
1 parent 410ac93 commit d12e334

File tree

1 file changed

+32
-64
lines changed

1 file changed

+32
-64
lines changed

‎Sources/Analytics/AnalyticsClient.swift

Lines changed: 32 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -1078,10 +1078,8 @@ open class AnalyticsClient {
10781078
/// - parameter index: (query) Index name.
10791079
/// - parameter startDate: (query) Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
10801080
/// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
1081-
/// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
1082-
/// items can be retrieved. (optional, default to 10)
1083-
/// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
1084-
/// first 1000 items can be retrieved. (optional, default to 0)
1081+
/// - parameter limit: (query) Number of items to return. (optional, default to 10)
1082+
/// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
10851083
/// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
10861084
/// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
10871085
/// data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). (optional)
@@ -1123,11 +1121,9 @@ open class AnalyticsClient {
11231121
//
11241122
// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
11251123
//
1126-
// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
1127-
// items can be retrieved. (optional, default to 10)
1124+
// - parameter limit: (query) Number of items to return. (optional, default to 10)
11281125
//
1129-
// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
1130-
// first 1000 items can be retrieved. (optional, default to 0)
1126+
// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
11311127
//
11321128
// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
11331129
// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
@@ -1173,10 +1169,8 @@ open class AnalyticsClient {
11731169
/// - parameter index: (query) Index name.
11741170
/// - parameter startDate: (query) Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
11751171
/// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
1176-
/// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
1177-
/// items can be retrieved. (optional, default to 10)
1178-
/// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
1179-
/// first 1000 items can be retrieved. (optional, default to 0)
1172+
/// - parameter limit: (query) Number of items to return. (optional, default to 10)
1173+
/// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
11801174
/// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
11811175
/// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
11821176
/// data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). (optional)
@@ -1218,11 +1212,9 @@ open class AnalyticsClient {
12181212
//
12191213
// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
12201214
//
1221-
// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
1222-
// items can be retrieved. (optional, default to 10)
1215+
// - parameter limit: (query) Number of items to return. (optional, default to 10)
12231216
//
1224-
// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
1225-
// first 1000 items can be retrieved. (optional, default to 0)
1217+
// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
12261218
//
12271219
// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
12281220
// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
@@ -1318,10 +1310,8 @@ open class AnalyticsClient {
13181310
/// - parameter index: (query) Index name.
13191311
/// - parameter startDate: (query) Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
13201312
/// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
1321-
/// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
1322-
/// items can be retrieved. (optional, default to 10)
1323-
/// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
1324-
/// first 1000 items can be retrieved. (optional, default to 0)
1313+
/// - parameter limit: (query) Number of items to return. (optional, default to 10)
1314+
/// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
13251315
/// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
13261316
/// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
13271317
/// data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). (optional)
@@ -1363,11 +1353,9 @@ open class AnalyticsClient {
13631353
//
13641354
// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
13651355
//
1366-
// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
1367-
// items can be retrieved. (optional, default to 10)
1356+
// - parameter limit: (query) Number of items to return. (optional, default to 10)
13681357
//
1369-
// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
1370-
// first 1000 items can be retrieved. (optional, default to 0)
1358+
// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
13711359
//
13721360
// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
13731361
// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
@@ -1414,10 +1402,8 @@ open class AnalyticsClient {
14141402
/// - parameter search: (query) Search query. (optional)
14151403
/// - parameter startDate: (query) Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
14161404
/// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
1417-
/// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
1418-
/// items can be retrieved. (optional, default to 10)
1419-
/// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
1420-
/// first 1000 items can be retrieved. (optional, default to 0)
1405+
/// - parameter limit: (query) Number of items to return. (optional, default to 10)
1406+
/// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
14211407
/// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
14221408
/// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
14231409
/// data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). (optional)
@@ -1464,11 +1450,9 @@ open class AnalyticsClient {
14641450
//
14651451
// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
14661452
//
1467-
// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
1468-
// items can be retrieved. (optional, default to 10)
1453+
// - parameter limit: (query) Number of items to return. (optional, default to 10)
14691454
//
1470-
// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
1471-
// first 1000 items can be retrieved. (optional, default to 0)
1455+
// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
14721456
//
14731457
// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
14741458
// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
@@ -1518,10 +1502,8 @@ open class AnalyticsClient {
15181502
/// - parameter search: (query) Search query. (optional)
15191503
/// - parameter startDate: (query) Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
15201504
/// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
1521-
/// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
1522-
/// items can be retrieved. (optional, default to 10)
1523-
/// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
1524-
/// first 1000 items can be retrieved. (optional, default to 0)
1505+
/// - parameter limit: (query) Number of items to return. (optional, default to 10)
1506+
/// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
15251507
/// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
15261508
/// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
15271509
/// data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). (optional)
@@ -1572,11 +1554,9 @@ open class AnalyticsClient {
15721554
//
15731555
// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
15741556
//
1575-
// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
1576-
// items can be retrieved. (optional, default to 10)
1557+
// - parameter limit: (query) Number of items to return. (optional, default to 10)
15771558
//
1578-
// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
1579-
// first 1000 items can be retrieved. (optional, default to 0)
1559+
// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
15801560
//
15811561
// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
15821562
// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
@@ -1639,10 +1619,8 @@ open class AnalyticsClient {
16391619
/// - parameter search: (query) Search query. (optional)
16401620
/// - parameter startDate: (query) Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
16411621
/// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
1642-
/// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
1643-
/// items can be retrieved. (optional, default to 10)
1644-
/// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
1645-
/// first 1000 items can be retrieved. (optional, default to 0)
1622+
/// - parameter limit: (query) Number of items to return. (optional, default to 10)
1623+
/// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
16461624
/// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
16471625
/// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
16481626
/// data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). (optional)
@@ -1690,11 +1668,9 @@ open class AnalyticsClient {
16901668
//
16911669
// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
16921670
//
1693-
// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
1694-
// items can be retrieved. (optional, default to 10)
1671+
// - parameter limit: (query) Number of items to return. (optional, default to 10)
16951672
//
1696-
// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
1697-
// first 1000 items can be retrieved. (optional, default to 0)
1673+
// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
16981674
//
16991675
// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
17001676
// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
@@ -1747,10 +1723,8 @@ open class AnalyticsClient {
17471723
/// metrics related to click and conversion events are also included in the response. (optional, default to false)
17481724
/// - parameter startDate: (query) Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
17491725
/// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
1750-
/// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
1751-
/// items can be retrieved. (optional, default to 10)
1752-
/// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
1753-
/// first 1000 items can be retrieved. (optional, default to 0)
1726+
/// - parameter limit: (query) Number of items to return. (optional, default to 10)
1727+
/// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
17541728
/// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
17551729
/// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
17561730
/// data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). (optional)
@@ -1806,11 +1780,9 @@ open class AnalyticsClient {
18061780
//
18071781
// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
18081782
//
1809-
// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
1810-
// items can be retrieved. (optional, default to 10)
1783+
// - parameter limit: (query) Number of items to return. (optional, default to 10)
18111784
//
1812-
// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
1813-
// first 1000 items can be retrieved. (optional, default to 0)
1785+
// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
18141786
//
18151787
// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
18161788
// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
@@ -1869,10 +1841,8 @@ open class AnalyticsClient {
18691841
/// - parameter orderBy: (query) Attribute by which to order the response items. If the `clickAnalytics` parameter
18701842
/// is false, only `searchCount` is available. (optional)
18711843
/// - parameter direction: (query) Sorting direction of the results: ascending or descending. (optional)
1872-
/// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
1873-
/// items can be retrieved. (optional, default to 10)
1874-
/// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
1875-
/// first 1000 items can be retrieved. (optional, default to 0)
1844+
/// - parameter limit: (query) Number of items to return. (optional, default to 10)
1845+
/// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
18761846
/// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
18771847
/// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
18781848
/// data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). (optional)
@@ -1933,11 +1903,9 @@ open class AnalyticsClient {
19331903
//
19341904
// - parameter direction: (query) Sorting direction of the results: ascending or descending. (optional)
19351905
//
1936-
// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
1937-
// items can be retrieved. (optional, default to 10)
1906+
// - parameter limit: (query) Number of items to return. (optional, default to 10)
19381907
//
1939-
// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
1940-
// first 1000 items can be retrieved. (optional, default to 0)
1908+
// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
19411909
//
19421910
// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
19431911
// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics

0 commit comments

Comments
 (0)