Skip to content

Commit b8b8629

Browse files
kai687millotp
andauthored
fix(specs): update links and descriptions (#5392)
Co-authored-by: Pierre Millot <[email protected]>
1 parent 302c8b9 commit b8b8629

Some content is hidden

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

56 files changed

+166
-178
lines changed

specs/abtesting-v3/spec.yml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
openapi: 3.0.2
22
externalDocs:
3-
url: https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/
4-
description: |
5-
Related guide: A/B testing.
3+
url: https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing
4+
description: A/B testing.
65
info:
76
title: A/B Testing API
87
description: |

specs/abtesting/spec.yml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
openapi: 3.0.2
22
externalDocs:
3-
url: https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/
4-
description: |
5-
Related guide: A/B testing.
3+
url: https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing
4+
description: A/B testing.
65
info:
76
title: A/B Testing API
87
description: |

specs/advanced-personalization/spec.yml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ info:
77
## Client libraries
88
99
Use Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps.
10-
The official API clients are covered by Algolia's [Service Level Agreement](https://www.algolia.com/policies/sla/).
10+
The official API clients are covered by Algolia's [Service Level Agreement](https://www.algolia.com/policies/sla).
1111
12-
See: [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/)
12+
See: [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem)
1313
1414
## Base URLs
1515
@@ -51,7 +51,7 @@ info:
5151
5252
- `x-ratelimit-limit`: The number of requests allowed every 60 seconds.
5353
- `x-ratelimit-remaining`: The number of requests remaining in the current 60 second period.
54-
- `x-ratelimit-reset`: [Unix timestamp](https://www.unixtimestamp.com/) of the next time period.
54+
- `x-ratelimit-reset`: [Unix timestamp](https://www.unixtimestamp.com) of the next time period.
5555
5656
## Version
5757
@@ -72,7 +72,8 @@ servers:
7272
enum: [eu, us]
7373
default: eu
7474
externalDocs:
75-
url: https://www.algolia.com/doc/guides/personalization/ai-personalization/what-is-ai-personalization/
75+
url: https://www.algolia.com/doc/guides/personalization/ai-personalization/what-is-ai-personalization
76+
description: What is Advanced Personalization.
7677
security:
7778
- appId: []
7879
apiKey: []
@@ -91,9 +92,8 @@ tags:
9192
9293
User profiles contain the affinities each user has for the different facets in your index.
9394
externalDocs:
94-
url: https://www.algolia.com/doc/guides/personalization/ai-personalization/what-is-ai-personalization/concepts/user-profiles/
95-
description: |
96-
Related guide: User Profiles.
95+
url: https://www.algolia.com/doc/guides/personalization/ai-personalization/what-is-ai-personalization/concepts/user-profiles
96+
description: User profiles.
9797
x-tagGroups:
9898
- name: Advanced Personalization
9999
tags:

specs/analytics/common/parameters.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ Tags:
107107
108108
You can combine multiple tags with `OR` and `AND`.
109109
Tags must be URL-encoded.
110-
For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
110+
For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments).
111111
example: 'device:mobile%20phone'
112112
schema:
113113
type: string

specs/analytics/paths/click/getAddToCartRate.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ get:
1717
**There's a difference between a 0 and null add-to-cart rate when `clickAnalytics` is enabled:**
1818
1919
- **Null** means there were no queries: since Algolia didn't receive any events, the add-to-cart rate is null.
20-
- **0** mean there _were_ queries but no [add-to-cart events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received.
20+
- **0** mean there _were_ queries but no [add-to-cart events](https://www.algolia.com/doc/guides/sending-events/getting-started) were received.
2121
parameters:
2222
- $ref: '../../../common/parameters.yml#/Index'
2323
- $ref: '../../../common/parameters.yml#/StartDate'

specs/analytics/paths/click/getAverageClickPosition.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ get:
1212
For example, if users only ever click on the first result for any search, the average click position is 1.
1313
By default, the analyzed period includes the last eight days including the current day.
1414
15-
An average of `null` when `clickAnalytics` is enabled means Algolia didn't receive any [click events](https://www.algolia.com/doc/guides/sending-events/getting-started/) for the queries.
15+
An average of `null` when `clickAnalytics` is enabled means Algolia didn't receive any [click events](https://www.algolia.com/doc/guides/sending-events/getting-started) for the queries.
1616
The average is `null` until Algolia receives at least one click event.
1717
parameters:
1818
- $ref: '../../../common/parameters.yml#/Index'

specs/analytics/paths/click/getClickPositions.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ get:
1010
1111
This lets you check how many clicks the first, second, or tenth search results receive.
1212
13-
An average of `0` when `clickAnalytics` is enabled means Algolia didn't receive any [click events](https://www.algolia.com/doc/guides/sending-events/getting-started/) for the queries.
13+
An average of `0` when `clickAnalytics` is enabled means Algolia didn't receive any [click events](https://www.algolia.com/doc/guides/sending-events/getting-started) for the queries.
1414
parameters:
1515
- $ref: '../../../common/parameters.yml#/Index'
1616
- $ref: '../../../common/parameters.yml#/StartDate'

specs/analytics/paths/click/getClickThroughRate.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ get:
1313
**There's a difference between a 0 and null CTR when `clickAnalytics` is enabled:**
1414
1515
- **Null** means there were no queries: since Algolia didn't receive any events, CTR is null.
16-
- **0** mean there _were_ queries but no [click events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received.
16+
- **0** mean there _were_ queries but no [click events](https://www.algolia.com/doc/guides/sending-events/getting-started) were received.
1717
parameters:
1818
- $ref: '../../../common/parameters.yml#/Index'
1919
- $ref: '../../../common/parameters.yml#/StartDate'

specs/analytics/paths/click/getConversionRate.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ get:
1313
**There's a difference between a 0 and null CR when `clickAnalytics` is enabled:**
1414
1515
- **Null** means there were no queries: since Algolia didn't receive any events, CR is null.
16-
- **0** mean there _were_ queries but no [conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received.
16+
- **0** mean there _were_ queries but no [conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started) were received.
1717
parameters:
1818
- $ref: '../../../common/parameters.yml#/Index'
1919
- $ref: '../../../common/parameters.yml#/StartDate'

specs/analytics/paths/click/getPurchaseRate.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ get:
1717
**There's a difference between a 0 and null purchase rate when `clickAnalytics` is enabled:**
1818
1919
- **Null** means there were no queries: since Algolia didn't receive any events, the purchase rate is null.
20-
- **0** mean there _were_ queries but no [purchase conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received.
20+
- **0** mean there _were_ queries but no [purchase conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started) were received.
2121
parameters:
2222
- $ref: '../../../common/parameters.yml#/Index'
2323
- $ref: '../../../common/parameters.yml#/StartDate'

0 commit comments

Comments
 (0)