Skip to content

Commit 99e4bdf

Browse files
kai687shortcuts
andauthored
feat(specs): add acl permissions to operations (#2555)
Co-authored-by: Clément Vannicatte <vannicattec@gmail.com>
1 parent 3e28dca commit 99e4bdf

File tree

88 files changed

+304
-14
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

88 files changed

+304
-14
lines changed

specs/abtesting/paths/abtest.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ get:
22
tags:
33
- abtest
44
operationId: getABTest
5+
x-acl:
6+
- analytics
57
summary: Get A/B test details.
68
description: >
79
Get specific details for an A/B test.
@@ -29,6 +31,8 @@ delete:
2931
tags:
3032
- abtest
3133
operationId: deleteABTest
34+
x-acl:
35+
- editSettings
3236
summary: Delete an A/B test.
3337
description: >
3438
Delete an A/B test.

specs/abtesting/paths/abtests.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ post:
22
tags:
33
- abtest
44
operationId: addABTests
5+
x-acl:
6+
- editSettings
57
summary: Create an A/B test.
68
description: Creates an A/B test.
79
requestBody:
@@ -48,6 +50,8 @@ get:
4850
tags:
4951
- abtest
5052
operationId: listABTests
53+
x-acl:
54+
- analytics
5155
summary: List all A/B tests.
5256
description: List all A/B tests.
5357
parameters:

specs/abtesting/paths/stopABTest.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@ post:
22
tags:
33
- abtest
44
operationId: stopABTest
5+
x-acl:
6+
- editSettings
57
summary: Stop an A/B test.
68
description: >
79
If stopped, the test is over and can't be restarted.
810
There is now only one index, receiving 100% of all search requests.
9-
11+
1012
The data gathered for stopped A/B tests is retained.
1113
1214
To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).

specs/analytics/paths/click/getAverageClickPosition.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ get:
22
tags:
33
- click
44
operationId: getAverageClickPosition
5+
x-acl:
6+
- analytics
57
summary: Get average click position.
68
description: >
79
Return the average click position for the complete time range and for individual days.

specs/analytics/paths/click/getClickPositions.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ get:
22
tags:
33
- click
44
operationId: getClickPositions
5+
x-acl:
6+
- analytics
57
summary: Get click positions.
68
description: |
79
Show the number of clicks events and their associated position in the search results.
@@ -46,7 +48,7 @@ get:
4648
- For positions 11 to 20, all click events are grouped
4749
- For positions 21 and up, all click events are grouped.
4850
type: array
49-
example: [10,10]
51+
example: [10, 10]
5052
items:
5153
type: integer
5254
clickCount:

specs/analytics/paths/click/getClickThroughRate.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ get:
22
tags:
33
- click
44
operationId: getClickThroughRate
5+
x-acl:
6+
- analytics
57
summary: Get click-through rate (CTR).
68
description: Returns a [click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
79
parameters:

specs/analytics/paths/click/getConversionRate.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ get:
22
tags:
33
- click
44
operationId: getConversationRate
5+
x-acl:
6+
- analytics
57
summary: Get conversion rate (CR).
68
description: Return a [conversion rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate).
79
parameters:

specs/analytics/paths/search/getNoClickRate.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ get:
22
tags:
33
- search
44
operationId: getNoClickRate
5+
x-acl:
6+
- analytics
57
summary: Get no click rate.
68
description: Returns the rate at which searches don't lead to any clicks. The endpoint returns a value for the complete given time range, as well as a value per day. It also returns the count of searches and searches without clicks.
79
parameters:

specs/analytics/paths/search/getNoResultsRate.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@ get:
22
tags:
33
- search
44
operationId: getNoResultsRate
5+
x-acl:
6+
- analytics
57
summary: Get no results rate.
6-
description: Returns the rate at which searches didn't return any results.
8+
description: Returns the rate at which searches didn't return any results.
79
parameters:
810
- $ref: '../../../common/parameters.yml#/Index'
911
- $ref: '../../../common/parameters.yml#/StartDate'

specs/analytics/paths/search/getSearchesCount.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ get:
22
tags:
33
- search
44
operationId: getSearchesCount
5+
x-acl:
6+
- analytics
57
summary: Get number of searches.
68
description: Returns the number of searches within a time range.
79
parameters:

0 commit comments

Comments
 (0)