From 830d3f02143acbf6e9f3df9a5f935b6f17c4825b Mon Sep 17 00:00:00 2001 From: Kai Welke Date: Mon, 17 Nov 2025 11:47:13 +0100 Subject: [PATCH 1/2] fix(specs): use summary fields --- specs/abtesting-v3/spec.yml | 3 +-- specs/abtesting/spec.yml | 3 +-- specs/advanced-personalization/spec.yml | 3 +-- specs/analytics/spec.yml | 3 +-- specs/composition/spec.yml | 3 +-- specs/crawler/spec.yml | 3 +-- specs/ingestion/spec.yml | 2 +- specs/insights/spec.yml | 2 +- specs/monitoring/spec.yml | 3 +-- specs/personalization/spec.yml | 3 +-- specs/query-suggestions/spec.yml | 2 +- specs/recommend/spec.yml | 3 +-- specs/search/spec.yml | 3 +-- 13 files changed, 13 insertions(+), 23 deletions(-) diff --git a/specs/abtesting-v3/spec.yml b/specs/abtesting-v3/spec.yml index 2f8c89e8bd8..d4e951a41b3 100644 --- a/specs/abtesting-v3/spec.yml +++ b/specs/abtesting-v3/spec.yml @@ -4,9 +4,8 @@ externalDocs: description: A/B testing. info: title: A/B Testing API + summary: The Algolia A/B Testing API lets you manage your Algolia A/B tests to optimize your search experience description: | - The Algolia A/B Testing API lets you manage your Algolia A/B tests to optimize your search experience. - ## Base URLs The base URLs for requests to the A/B testing API are: diff --git a/specs/abtesting/spec.yml b/specs/abtesting/spec.yml index bd5d5837cf5..29c259fedf3 100644 --- a/specs/abtesting/spec.yml +++ b/specs/abtesting/spec.yml @@ -4,9 +4,8 @@ externalDocs: description: A/B testing. info: title: A/B Testing API + summary: The Algolia A/B Testing API lets you manage your Algolia A/B tests to optimize your search experience description: | - The Algolia A/B Testing API lets you manage your Algolia A/B tests to optimize your search experience. - ## Base URLs The base URLs for requests to the A/B testing API are: diff --git a/specs/advanced-personalization/spec.yml b/specs/advanced-personalization/spec.yml index 668b77db05b..d1bd61e0022 100644 --- a/specs/advanced-personalization/spec.yml +++ b/specs/advanced-personalization/spec.yml @@ -1,9 +1,8 @@ openapi: 3.0.2 info: title: Advanced Personalization API + summary: The Advanced Personalization API lets you access user profiles built based on the behavior of your users on your website or app description: | - The Advanced Personalization API lets you access user profiles built based on the behavior of your users on your website or app. - ## Client libraries Use Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps. diff --git a/specs/analytics/spec.yml b/specs/analytics/spec.yml index 1c2f986b205..0aca1a919f6 100644 --- a/specs/analytics/spec.yml +++ b/specs/analytics/spec.yml @@ -4,9 +4,8 @@ externalDocs: description: Search analytics. info: title: Analytics API + summary: The Analytics API gives you access to metrics related to your Algolia search experience description: | - The Analytics API gives you access to metrics related to your Algolia search experience. - ## Base URLs The base URLs for requests to the Analytics API are: diff --git a/specs/composition/spec.yml b/specs/composition/spec.yml index 60a668301f0..224b17e3586 100644 --- a/specs/composition/spec.yml +++ b/specs/composition/spec.yml @@ -1,9 +1,8 @@ openapi: 3.0.2 info: title: Composition API + summary: The Algolia Composition API lets you run composed search requests on your Compositions description: | - The Algolia Composition API lets you run composed search requests on your Compositions. - ## Client libraries Use Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps. diff --git a/specs/crawler/spec.yml b/specs/crawler/spec.yml index a4f9f030ec7..b9d081d72ba 100644 --- a/specs/crawler/spec.yml +++ b/specs/crawler/spec.yml @@ -1,9 +1,8 @@ openapi: 3.0.2 info: title: Crawler API + summary: The Crawler API lets you manage and run your crawlers description: | - The Crawler API lets you manage and run your crawlers. - ## Base URL The base URL for making requests to the Crawler API is: diff --git a/specs/ingestion/spec.yml b/specs/ingestion/spec.yml index 1dadc409380..f8f1b2c0abb 100644 --- a/specs/ingestion/spec.yml +++ b/specs/ingestion/spec.yml @@ -1,8 +1,8 @@ openapi: 3.0.2 info: title: Ingestion API + summary: The Ingestion API lets you connect third-party services and platforms with Algolia and schedule tasks to ingest your data description: | - The Ingestion API lets you connect third-party services and platforms with Algolia and schedule tasks to ingest your data. The Ingestion API powers the no-code [data connectors](https://dashboard.algolia.com/connectors). ## Base URLs diff --git a/specs/insights/spec.yml b/specs/insights/spec.yml index ec46775f29a..05c337fcdc5 100644 --- a/specs/insights/spec.yml +++ b/specs/insights/spec.yml @@ -1,8 +1,8 @@ openapi: 3.0.2 info: title: Insights API + summary: The Insights API lets you collect events related to your search and discovery experience description: | - The Insights API lets you collect events related to your search and discovery experience. Events represent user interactions with your app or website. They unlock powerful features, such as recommendations, personalization, smarter search results, and analytics that help you optimize your user experience. diff --git a/specs/monitoring/spec.yml b/specs/monitoring/spec.yml index 15747ec6006..69f57697c8e 100644 --- a/specs/monitoring/spec.yml +++ b/specs/monitoring/spec.yml @@ -1,9 +1,8 @@ openapi: 3.0.2 info: title: Algolia Monitoring API + summary: The Monitoring API lets you check the status of your Algolia infrastructure description: | - The Monitoring API lets you check the status of your Algolia infrastructure. - ## Base URLs The base URL for requests to the Monitoring API is: diff --git a/specs/personalization/spec.yml b/specs/personalization/spec.yml index ea33f901a7e..a251bf11628 100644 --- a/specs/personalization/spec.yml +++ b/specs/personalization/spec.yml @@ -1,9 +1,8 @@ openapi: 3.0.2 info: title: Personalization API + summary: The Personalization API lets you access user profiles built from the personalization strategy description: | - The Personalization API lets you access user profiles built from the personalization strategy. - ## Base URLs The base URLs for requests to the Personalization API are: diff --git a/specs/query-suggestions/spec.yml b/specs/query-suggestions/spec.yml index f8266bb44a0..899c55e2c50 100644 --- a/specs/query-suggestions/spec.yml +++ b/specs/query-suggestions/spec.yml @@ -1,8 +1,8 @@ openapi: 3.0.2 info: title: Query Suggestions API + summary: The Query Suggestions API lets you manage your Query Suggestions configurations description: | - The Query Suggestions API lets you manage your Query Suggestions configurations. Query Suggestions add new indices to your Algolia application with popular search queries, external suggestions, or facet values. In your user interface, you can query the Query Suggestions indices like regular indices and add [suggested searches](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/query-suggestions/js) to guide users and speed up their search. diff --git a/specs/recommend/spec.yml b/specs/recommend/spec.yml index d3785405d8b..b98c161237c 100644 --- a/specs/recommend/spec.yml +++ b/specs/recommend/spec.yml @@ -1,9 +1,8 @@ openapi: 3.0.2 info: title: Recommend API + summary: The Recommend API lets you retrieve recommendations from one of Algolia's AI recommendation models that you previously trained on your data description: | - The Recommend API lets you retrieve recommendations from one of Algolia's AI recommendation models that you previously trained on your data. - ## Client libraries Use Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps. diff --git a/specs/search/spec.yml b/specs/search/spec.yml index 917b088c700..aeca0039456 100644 --- a/specs/search/spec.yml +++ b/specs/search/spec.yml @@ -1,9 +1,8 @@ openapi: 3.0.2 info: title: Search API + summary: The Algolia Search API lets you search, configure, and manage your indices and records description: | - The Algolia Search API lets you search, configure, and manage your indices and records. - ## Client libraries Use Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps. From 3d0c9411b2aaf8b0004f56ce6aa5b3d89223ef89 Mon Sep 17 00:00:00 2001 From: Pierre Millot Date: Thu, 20 Nov 2025 11:35:31 +0100 Subject: [PATCH 2/2] skip validate --- scripts/pre-gen/generateOpenapitools.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/scripts/pre-gen/generateOpenapitools.ts b/scripts/pre-gen/generateOpenapitools.ts index d7460001fa8..2bc1f916455 100644 --- a/scripts/pre-gen/generateOpenapitools.ts +++ b/scripts/pre-gen/generateOpenapitools.ts @@ -35,6 +35,7 @@ export async function generateOpenapitools( mode, ...additionalProperties, }, + skipValidateSpec: true, 'openapi-normalizer': { // if this is set to true, it causes a breaking change on PlatformWithNone, this can be removed in the next major SIMPLIFY_ONEOF_ANYOF_ENUM: false,