Skip to content

Commit c286dce

Browse files
kai687millotp
andauthored
fix(specs): use summary fields (#5645)
Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
1 parent f7133c8 commit c286dce

File tree

14 files changed

+14
-23
lines changed

14 files changed

+14
-23
lines changed

scripts/pre-gen/generateOpenapitools.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ export async function generateOpenapitools(
3535
mode,
3636
...additionalProperties,
3737
},
38+
skipValidateSpec: true,
3839
'openapi-normalizer': {
3940
// if this is set to true, it causes a breaking change on PlatformWithNone, this can be removed in the next major
4041
SIMPLIFY_ONEOF_ANYOF_ENUM: false,

specs/abtesting-v3/spec.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,8 @@ externalDocs:
44
description: A/B testing.
55
info:
66
title: A/B Testing API
7+
summary: The Algolia A/B Testing API lets you manage your Algolia A/B tests to optimize your search experience
78
description: |
8-
The Algolia A/B Testing API lets you manage your Algolia A/B tests to optimize your search experience.
9-
109
## Base URLs
1110
1211
The base URLs for requests to the A/B testing API are:

specs/abtesting/spec.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,8 @@ externalDocs:
44
description: A/B testing.
55
info:
66
title: A/B Testing API
7+
summary: The Algolia A/B Testing API lets you manage your Algolia A/B tests to optimize your search experience
78
description: |
8-
The Algolia A/B Testing API lets you manage your Algolia A/B tests to optimize your search experience.
9-
109
## Base URLs
1110
1211
The base URLs for requests to the A/B testing API are:

specs/advanced-personalization/spec.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
openapi: 3.0.2
22
info:
33
title: Advanced Personalization API
4+
summary: The Advanced Personalization API lets you access user profiles built based on the behavior of your users on your website or app
45
description: |
5-
The Advanced Personalization API lets you access user profiles built based on the behavior of your users on your website or app.
6-
76
## Client libraries
87
98
Use Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps.

specs/analytics/spec.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,8 @@ externalDocs:
44
description: Search analytics.
55
info:
66
title: Analytics API
7+
summary: The Analytics API gives you access to metrics related to your Algolia search experience
78
description: |
8-
The Analytics API gives you access to metrics related to your Algolia search experience.
9-
109
## Base URLs
1110
1211
The base URLs for requests to the Analytics API are:

specs/composition/spec.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
openapi: 3.0.2
22
info:
33
title: Composition API
4+
summary: The Algolia Composition API lets you run composed search requests on your Compositions
45
description: |
5-
The Algolia Composition API lets you run composed search requests on your Compositions.
6-
76
## Client libraries
87
98
Use Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps.

specs/crawler/spec.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
openapi: 3.0.2
22
info:
33
title: Crawler API
4+
summary: The Crawler API lets you manage and run your crawlers
45
description: |
5-
The Crawler API lets you manage and run your crawlers.
6-
76
## Base URL
87
98
The base URL for making requests to the Crawler API is:

specs/ingestion/spec.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
openapi: 3.0.2
22
info:
33
title: Ingestion API
4+
summary: The Ingestion API lets you connect third-party services and platforms with Algolia and schedule tasks to ingest your data
45
description: |
5-
The Ingestion API lets you connect third-party services and platforms with Algolia and schedule tasks to ingest your data.
66
The Ingestion API powers the no-code [data connectors](https://dashboard.algolia.com/connectors).
77
88
## Base URLs

specs/insights/spec.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
openapi: 3.0.2
22
info:
33
title: Insights API
4+
summary: The Insights API lets you collect events related to your search and discovery experience
45
description: |
5-
The Insights API lets you collect events related to your search and discovery experience.
66
Events represent user interactions with your app or website.
77
They unlock powerful features, such as recommendations, personalization, smarter search results,
88
and analytics that help you optimize your user experience.

specs/monitoring/spec.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
openapi: 3.0.2
22
info:
33
title: Algolia Monitoring API
4+
summary: The Monitoring API lets you check the status of your Algolia infrastructure
45
description: |
5-
The Monitoring API lets you check the status of your Algolia infrastructure.
6-
76
## Base URLs
87
98
The base URL for requests to the Monitoring API is:

0 commit comments

Comments
 (0)