Skip to content

Commit

Permalink
docs(analytics): constrain pagination only to limit query parameter (…
Browse files Browse the repository at this point in the history 
…generated)

algolia/api-clients-automation#4012

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Fernando Beck <fe.beck25@gmail.com>
Co-authored-by: shortcuts <vannicattec@gmail.com>
  • Loading branch information
@algolia-bot @febeck @shortcuts
3 people committed Oct 21, 2024
1 parent 410ac93 commit d12e334
Showing 1 changed file with 32 additions and 64 deletions.
96 changes: 32 additions & 64 deletions Sources/Analytics/AnalyticsClient.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1078,10 +1078,8 @@ open class AnalyticsClient {
/// - parameter index: (query) Index name.
/// - parameter startDate: (query) Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
/// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
/// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
/// items can be retrieved. (optional, default to 10)
/// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
/// first 1000 items can be retrieved. (optional, default to 0)
/// - parameter limit: (query) Number of items to return. (optional, default to 10)
/// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
/// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
/// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
/// data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). (optional)
Expand Down Expand Up @@ -1123,11 +1121,9 @@ open class AnalyticsClient {
//
// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
//
// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
// items can be retrieved. (optional, default to 10)
// - parameter limit: (query) Number of items to return. (optional, default to 10)
//
// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
// first 1000 items can be retrieved. (optional, default to 0)
// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
//
// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
Expand Down Expand Up @@ -1173,10 +1169,8 @@ open class AnalyticsClient {
/// - parameter index: (query) Index name.
/// - parameter startDate: (query) Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
/// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
/// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
/// items can be retrieved. (optional, default to 10)
/// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
/// first 1000 items can be retrieved. (optional, default to 0)
/// - parameter limit: (query) Number of items to return. (optional, default to 10)
/// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
/// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
/// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
/// data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). (optional)
Expand Down Expand Up @@ -1218,11 +1212,9 @@ open class AnalyticsClient {
//
// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
//
// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
// items can be retrieved. (optional, default to 10)
// - parameter limit: (query) Number of items to return. (optional, default to 10)
//
// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
// first 1000 items can be retrieved. (optional, default to 0)
// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
//
// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
Expand Down Expand Up @@ -1318,10 +1310,8 @@ open class AnalyticsClient {
/// - parameter index: (query) Index name.
/// - parameter startDate: (query) Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
/// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
/// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
/// items can be retrieved. (optional, default to 10)
/// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
/// first 1000 items can be retrieved. (optional, default to 0)
/// - parameter limit: (query) Number of items to return. (optional, default to 10)
/// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
/// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
/// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
/// data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). (optional)
Expand Down Expand Up @@ -1363,11 +1353,9 @@ open class AnalyticsClient {
//
// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
//
// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
// items can be retrieved. (optional, default to 10)
// - parameter limit: (query) Number of items to return. (optional, default to 10)
//
// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
// first 1000 items can be retrieved. (optional, default to 0)
// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
//
// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
Expand Down Expand Up @@ -1414,10 +1402,8 @@ open class AnalyticsClient {
/// - parameter search: (query) Search query. (optional)
/// - parameter startDate: (query) Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
/// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
/// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
/// items can be retrieved. (optional, default to 10)
/// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
/// first 1000 items can be retrieved. (optional, default to 0)
/// - parameter limit: (query) Number of items to return. (optional, default to 10)
/// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
/// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
/// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
/// data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). (optional)
Expand Down Expand Up @@ -1464,11 +1450,9 @@ open class AnalyticsClient {
//
// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
//
// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
// items can be retrieved. (optional, default to 10)
// - parameter limit: (query) Number of items to return. (optional, default to 10)
//
// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
// first 1000 items can be retrieved. (optional, default to 0)
// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
//
// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
Expand Down Expand Up @@ -1518,10 +1502,8 @@ open class AnalyticsClient {
/// - parameter search: (query) Search query. (optional)
/// - parameter startDate: (query) Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
/// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
/// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
/// items can be retrieved. (optional, default to 10)
/// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
/// first 1000 items can be retrieved. (optional, default to 0)
/// - parameter limit: (query) Number of items to return. (optional, default to 10)
/// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
/// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
/// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
/// data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). (optional)
Expand Down Expand Up @@ -1572,11 +1554,9 @@ open class AnalyticsClient {
//
// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
//
// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
// items can be retrieved. (optional, default to 10)
// - parameter limit: (query) Number of items to return. (optional, default to 10)
//
// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
// first 1000 items can be retrieved. (optional, default to 0)
// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
//
// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
Expand Down Expand Up @@ -1639,10 +1619,8 @@ open class AnalyticsClient {
/// - parameter search: (query) Search query. (optional)
/// - parameter startDate: (query) Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
/// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
/// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
/// items can be retrieved. (optional, default to 10)
/// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
/// first 1000 items can be retrieved. (optional, default to 0)
/// - parameter limit: (query) Number of items to return. (optional, default to 10)
/// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
/// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
/// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
/// data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). (optional)
Expand Down Expand Up @@ -1690,11 +1668,9 @@ open class AnalyticsClient {
//
// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
//
// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
// items can be retrieved. (optional, default to 10)
// - parameter limit: (query) Number of items to return. (optional, default to 10)
//
// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
// first 1000 items can be retrieved. (optional, default to 0)
// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
//
// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
Expand Down Expand Up @@ -1747,10 +1723,8 @@ open class AnalyticsClient {
/// metrics related to click and conversion events are also included in the response. (optional, default to false)
/// - parameter startDate: (query) Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
/// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
/// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
/// items can be retrieved. (optional, default to 10)
/// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
/// first 1000 items can be retrieved. (optional, default to 0)
/// - parameter limit: (query) Number of items to return. (optional, default to 10)
/// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
/// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
/// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
/// data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). (optional)
Expand Down Expand Up @@ -1806,11 +1780,9 @@ open class AnalyticsClient {
//
// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
//
// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
// items can be retrieved. (optional, default to 10)
// - parameter limit: (query) Number of items to return. (optional, default to 10)
//
// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
// first 1000 items can be retrieved. (optional, default to 0)
// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
//
// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
Expand Down Expand Up @@ -1869,10 +1841,8 @@ open class AnalyticsClient {
/// - parameter orderBy: (query) Attribute by which to order the response items. If the `clickAnalytics` parameter
/// is false, only `searchCount` is available. (optional)
/// - parameter direction: (query) Sorting direction of the results: ascending or descending. (optional)
/// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
/// items can be retrieved. (optional, default to 10)
/// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
/// first 1000 items can be retrieved. (optional, default to 0)
/// - parameter limit: (query) Number of items to return. (optional, default to 10)
/// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
/// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
/// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
/// data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). (optional)
Expand Down Expand Up @@ -1933,11 +1903,9 @@ open class AnalyticsClient {
//
// - parameter direction: (query) Sorting direction of the results: ascending or descending. (optional)
//
// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
// items can be retrieved. (optional, default to 10)
// - parameter limit: (query) Number of items to return. (optional, default to 10)
//
// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
// first 1000 items can be retrieved. (optional, default to 0)
// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
//
// - parameter tags: (query) Tags by which to segment the analytics. You can combine multiple tags with `OR` and
// `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics
Expand Down

0 comments on commit d12e334

Please sign in to comment.