Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(specs): update analytics and abtesting max pagination query limit #3696

Merged
merged 7 commits into from
Oct 3, 2024
Merged

fix(specs): update analytics and abtesting max pagination query limit #3696

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7f02c56
feat(analytics): move offset and limit documentation to analytics to …
febeck Sep 10, 2024
18e0c1c
refactor(analytics): update documentation import to use local analyti…
febeck Sep 10, 2024
fe6e130
refactor(abtests): remove single usage declaration for offset and lim…
febeck Sep 10, 2024
f00c4bc
fix(analytics): missing space
febeck Sep 12, 2024
a2a408e
Merge branch 'main' into docs/analytics/update_max_pagination_query_l…
millotp Sep 12, 2024
0770e79
Merge branch 'main' into docs/analytics/update_max_pagination_query_l…
febeck Oct 2, 2024
031d951
Merge branch 'main' into docs/analytics/update_max_pagination_query_l…
febeck Oct 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions specs/abtesting/paths/abtests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,21 @@ get:
summary: List all A/B tests
description: Lists all A/B tests you configured for this application.
parameters:
- $ref: '../../common/parameters.yml#/Offset'
- $ref: '../../common/parameters.yml#/Limit'
- name: offset
in: query
description: Position of the first item to return.
required: false
schema:
type: integer
default: 0
minimum: 0
- name: limit
in: query
description: Number of items to return.
required: false
schema:
type: integer
default: 10
- name: indexPrefix
in: query
description: Index name prefix. Only A/B tests for indices starting with this string are included in the response.
Expand Down
28 changes: 28 additions & 0 deletions specs/analytics/common/parameters.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,34 @@ OrderBy:
schema:
$ref: '#/orderBy'

Offset:
in: query
name: offset
description: |
Position of the first item to return.

Combined with the `limit` parameter, only the first 1000 items can be retrieved.
required: false
schema:
type: integer
default: 0
minimum: 0
maximum: 1000

Limit:
in: query
name: limit
description: |
Number of items to return.

Combined with the `offset` parameter, only the first 1000 items can be retrieved.

required: false
schema:
type: integer
default: 10
maximum: 1000

# private
orderBy:
type: string
Expand Down
4 changes: 2 additions & 2 deletions specs/analytics/paths/search/getSearchesNoClicks.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ get:
- $ref: '../../../common/parameters.yml#/Index'
- $ref: '../../../common/parameters.yml#/StartDate'
- $ref: '../../../common/parameters.yml#/EndDate'
- $ref: '../../../common/parameters.yml#/Limit'
- $ref: '../../../common/parameters.yml#/Offset'
- $ref: '../../common/parameters.yml#/Limit'
- $ref: '../../common/parameters.yml#/Offset'
- $ref: '../../common/parameters.yml#/Tags'
responses:
'200':
Expand Down
4 changes: 2 additions & 2 deletions specs/analytics/paths/search/getSearchesNoResults.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ get:
- $ref: '../../../common/parameters.yml#/Index'
- $ref: '../../../common/parameters.yml#/StartDate'
- $ref: '../../../common/parameters.yml#/EndDate'
- $ref: '../../../common/parameters.yml#/Limit'
- $ref: '../../../common/parameters.yml#/Offset'
- $ref: '../../common/parameters.yml#/Limit'
- $ref: '../../common/parameters.yml#/Offset'
- $ref: '../../common/parameters.yml#/Tags'
responses:
'200':
Expand Down
4 changes: 2 additions & 2 deletions specs/analytics/paths/search/getTopCountries.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ get:
- $ref: '../../../common/parameters.yml#/Index'
- $ref: '../../../common/parameters.yml#/StartDate'
- $ref: '../../../common/parameters.yml#/EndDate'
- $ref: '../../../common/parameters.yml#/Limit'
- $ref: '../../../common/parameters.yml#/Offset'
- $ref: '../../common/parameters.yml#/Limit'
- $ref: '../../common/parameters.yml#/Offset'
- $ref: '../../common/parameters.yml#/Tags'
responses:
'200':
Expand Down
4 changes: 2 additions & 2 deletions specs/analytics/paths/search/getTopFilterAttributes.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ get:
- $ref: '../../common/parameters.yml#/Search'
- $ref: '../../../common/parameters.yml#/StartDate'
- $ref: '../../../common/parameters.yml#/EndDate'
- $ref: '../../../common/parameters.yml#/Limit'
- $ref: '../../../common/parameters.yml#/Offset'
- $ref: '../../common/parameters.yml#/Limit'
- $ref: '../../common/parameters.yml#/Offset'
- $ref: '../../common/parameters.yml#/Tags'
responses:
'200':
Expand Down
4 changes: 2 additions & 2 deletions specs/analytics/paths/search/getTopFilterForAttribute.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ get:
- $ref: '../../common/parameters.yml#/Search'
- $ref: '../../../common/parameters.yml#/StartDate'
- $ref: '../../../common/parameters.yml#/EndDate'
- $ref: '../../../common/parameters.yml#/Limit'
- $ref: '../../../common/parameters.yml#/Offset'
- $ref: '../../common/parameters.yml#/Limit'
- $ref: '../../common/parameters.yml#/Offset'
- $ref: '../../common/parameters.yml#/Tags'
responses:
'200':
Expand Down
4 changes: 2 additions & 2 deletions specs/analytics/paths/search/getTopFiltersNoResults.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ get:
- $ref: '../../common/parameters.yml#/Search'
- $ref: '../../../common/parameters.yml#/StartDate'
- $ref: '../../../common/parameters.yml#/EndDate'
- $ref: '../../../common/parameters.yml#/Limit'
- $ref: '../../../common/parameters.yml#/Offset'
- $ref: '../../common/parameters.yml#/Limit'
- $ref: '../../common/parameters.yml#/Offset'
- $ref: '../../common/parameters.yml#/Tags'
responses:
'200':
Expand Down
4 changes: 2 additions & 2 deletions specs/analytics/paths/search/getTopHits.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ get:
- $ref: '../../common/parameters.yml#/RevenueAnalytics'
- $ref: '../../../common/parameters.yml#/StartDate'
- $ref: '../../../common/parameters.yml#/EndDate'
- $ref: '../../../common/parameters.yml#/Limit'
- $ref: '../../../common/parameters.yml#/Offset'
- $ref: '../../common/parameters.yml#/Limit'
- $ref: '../../common/parameters.yml#/Offset'
- $ref: '../../common/parameters.yml#/Tags'
responses:
'200':
Expand Down
4 changes: 2 additions & 2 deletions specs/analytics/paths/search/getTopSearches.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ get:
- $ref: '../../../common/parameters.yml#/EndDate'
- $ref: '../../common/parameters.yml#/OrderBy'
- $ref: '../../common/parameters.yml#/Direction'
- $ref: '../../../common/parameters.yml#/Limit'
- $ref: '../../../common/parameters.yml#/Offset'
- $ref: '../../common/parameters.yml#/Limit'
- $ref: '../../common/parameters.yml#/Offset'
- $ref: '../../common/parameters.yml#/Tags'
responses:
'200':
Expand Down
19 changes: 0 additions & 19 deletions specs/common/parameters.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,25 +104,6 @@ HitsPerPage:
type: integer
default: 100

Offset:
in: query
name: offset
description: Position of the first item to return.
required: false
schema:
type: integer
default: 0
minimum: 0

Limit:
in: query
name: limit
description: Number of items to return.
required: false
schema:
type: integer
default: 10

# misc
objectID:
type: string
Expand Down
Loading