Skip to content

Synonyms API - Add refresh parameter #4298

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.

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 4 commits into from
Apr 25, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
36 changes: 32 additions & 4 deletions output/openapi/elasticsearch-openapi.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 2 additions & 4 deletions output/openapi/elasticsearch-serverless-openapi.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 9 additions & 7 deletions output/schema/schema-serverless.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

79 changes: 69 additions & 10 deletions output/schema/schema.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 5 additions & 2 deletions output/typescript/types.ts

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions specification/synonyms/_types/SynonymsUpdateResult.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ export class SynonymsUpdateResult {
result: Result

/**
* Updating synonyms in a synonym set reloads the associated analyzers.
* Updating synonyms in a synonym set can reload the associated analyzers in case refresh is set to true.
* This information is the analyzers reloading result.
*/
reload_analyzers_details: ReloadResult
reload_analyzers_details?: ReloadResult
}
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,13 @@ export interface Request extends RequestBase {
*/
rule_id: Id
}
query_parameters: {
/**
* If `true`, the request will refresh the analyzers with the deleted synonym rule and wait for the new synonyms to be available before returning.
* If `false`, analyzers will not be reloaded with the deleted synonym rule
* @server_default true
* @availability stack since=9.1.0
*/
refresh?: boolean
}
}
9 changes: 9 additions & 0 deletions specification/synonyms/put_synonym/SynonymsPutRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,13 @@ export interface Request extends RequestBase {
*/
synonyms_set: SynonymRule | SynonymRule[]
}
query_parameters: {
/**
* If `true`, the request will refresh the analyzers with the new synonyms set and wait for the new synonyms to be available before returning.
* If `false`, analyzers will not be reloaded with the new synonym set
* @server_default true
* @availability stack since=9.1.0
*/
refresh?: boolean
}
}
10 changes: 9 additions & 1 deletion specification/synonyms/put_synonym/SynonymsPutResponse.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,15 @@ import { Result } from '@_types/Result'

export class Response {
body: {
/**
* The update operation result.
*/
result: Result
reload_analyzers_details: ReloadResult

/**
* Updating a synonyms set can reload the associated analyzers in case refresh is set to true.
* This information is the analyzers reloading result.
*/
reload_analyzers_details?: ReloadResult
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -57,4 +57,13 @@ export interface Request extends RequestBase {
*/
synonyms: SynonymString
}
query_parameters: {
/**
* If `true`, the request will refresh the analyzers with the new synonym rule and wait for the new synonyms to be available before returning.
* If `false`, analyzers will not be reloaded with the new synonym rule
* @server_default true
* @availability stack since=9.1.0
*/
refresh?: boolean
}
}
Loading