Skip to content

fix(specs): use summary fields #5645

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

Merged
merged 3 commits into from
Nov 20, 2025
Merged

fix(specs): use summary fields #5645

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
830d3f0
fix(specs): use summary fields
kai687 Nov 17, 2025
3d0c941
skip validate
millotp Nov 20, 2025
52c858c
Merge branch 'main' into fix/use-summary-field
millotp Nov 20, 2025
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
1 change: 1 addition & 0 deletions scripts/pre-gen/generateOpenapitools.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
3 changes: 1 addition & 2 deletions specs/abtesting-v3/spec.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
3 changes: 1 addition & 2 deletions specs/abtesting/spec.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
3 changes: 1 addition & 2 deletions specs/advanced-personalization/spec.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
3 changes: 1 addition & 2 deletions specs/analytics/spec.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
3 changes: 1 addition & 2 deletions specs/composition/spec.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
3 changes: 1 addition & 2 deletions specs/crawler/spec.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 1 addition & 1 deletion specs/ingestion/spec.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion specs/insights/spec.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
3 changes: 1 addition & 2 deletions specs/monitoring/spec.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
3 changes: 1 addition & 2 deletions specs/personalization/spec.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 1 addition & 1 deletion specs/query-suggestions/spec.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
3 changes: 1 addition & 2 deletions specs/recommend/spec.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
3 changes: 1 addition & 2 deletions specs/search/spec.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand Down