Skip to content

Commit b42b3e3

Browse files
authored
Merge branch 'main' into renovate/proxy-2.x
2 parents 89deba5 + 5622505 commit b42b3e3

File tree

5 files changed

+46
-20
lines changed

5 files changed

+46
-20
lines changed

docs/reference/api-reference.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -980,7 +980,6 @@ PUT my-index-000001/_doc/1?version=2&version_type=external
980980
"id": "elkbee"
981981
}
982982
}
983-
```
984983

985984
In this example, the operation will succeed since the supplied version of 2 is higher than the current document version of 1.
986985
If the document was already updated and its version was set to 2 or higher, the indexing command will fail and result in a conflict (409 HTTP status code).
@@ -9211,7 +9210,7 @@ retrieval. This allows the configuration to be in an acceptable format to
92119210
be retrieved and then added to another cluster.
92129211

92139212
## client.ml.getDataFrameAnalyticsStats [_ml.get_data_frame_analytics_stats]
9214-
Get data frame analytics jobs usage info.
9213+
Get data frame analytics job stats.
92159214

92169215
[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-data-frame-analytics-stats)
92179216

@@ -9241,7 +9240,7 @@ there are no matches or only partial matches.
92419240
- **`verbose` (Optional, boolean)**: Defines whether the stats response should be verbose.
92429241

92439242
## client.ml.getDatafeedStats [_ml.get_datafeed_stats]
9244-
Get datafeeds usage info.
9243+
Get datafeed stats.
92459244
You can get statistics for multiple datafeeds in a single API request by
92469245
using a list of datafeeds or a wildcard expression. You can
92479246
get statistics for all datafeeds by using `_all`, by specifying `*` as the
@@ -9357,7 +9356,7 @@ influencers are sorted by the `influencer_score` value.
93579356
means it is unset and results are not limited to specific timestamps.
93589357

93599358
## client.ml.getJobStats [_ml.get_job_stats]
9360-
Get anomaly detection jobs usage info.
9359+
Get anomaly detection job stats.
93619360

93629361
[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-job-stats)
93639362

@@ -14245,6 +14244,8 @@ client.synonyms.deleteSynonymRule({ set_id, rule_id })
1424514244
#### Request (object) [_request_synonyms.delete_synonym_rule]
1424614245
- **`set_id` (string)**: The ID of the synonym set to update.
1424714246
- **`rule_id` (string)**: The ID of the synonym rule to delete.
14247+
- **`refresh` (Optional, boolean)**: If `true`, the request will refresh the analyzers with the deleted synonym rule and wait for the new synonyms to be available before returning.
14248+
If `false`, analyzers will not be reloaded with the deleted synonym rule
1424814249

1424914250
## client.synonyms.getSynonym [_synonyms.get_synonym]
1425014251
Get a synonym set.
@@ -14313,6 +14314,8 @@ client.synonyms.putSynonym({ id, synonyms_set })
1431314314
#### Request (object) [_request_synonyms.put_synonym]
1431414315
- **`id` (string)**: The ID of the synonyms set to be created or updated.
1431514316
- **`synonyms_set` ({ id, synonyms } | { id, synonyms }[])**: The synonym rules definitions for the synonyms set.
14317+
- **`refresh` (Optional, boolean)**: If `true`, the request will refresh the analyzers with the new synonyms set and wait for the new synonyms to be available before returning.
14318+
If `false`, analyzers will not be reloaded with the new synonym set
1431614319

1431714320
## client.synonyms.putSynonymRule [_synonyms.put_synonym_rule]
1431814321
Create or update a synonym rule.
@@ -14334,6 +14337,8 @@ client.synonyms.putSynonymRule({ set_id, rule_id, synonyms })
1433414337
- **`set_id` (string)**: The ID of the synonym set.
1433514338
- **`rule_id` (string)**: The ID of the synonym rule to be updated or created.
1433614339
- **`synonyms` (string)**: The synonym rule information definition, which must be in Solr format.
14340+
- **`refresh` (Optional, boolean)**: If `true`, the request will refresh the analyzers with the new synonym rule and wait for the new synonyms to be available before returning.
14341+
If `false`, analyzers will not be reloaded with the new synonym rule
1433714342

1433814343
## client.tasks.cancel [_tasks.cancel]
1433914344
Cancel a task.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@
6262
"@sinonjs/fake-timers": "14.0.0",
6363
"@types/debug": "4.1.12",
6464
"@types/ms": "2.1.0",
65-
"@types/node": "22.14.1",
65+
"@types/node": "22.15.2",
6666
"@types/sinonjs__fake-timers": "8.1.5",
6767
"@types/split2": "4.2.3",
6868
"@types/stoppable": "1.1.3",

src/api/api/ml.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2230,7 +2230,7 @@ export default class Ml {
22302230
}
22312231

22322232
/**
2233-
* Get data frame analytics jobs usage info.
2233+
* Get data frame analytics job stats.
22342234
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-data-frame-analytics-stats | Elasticsearch API documentation}
22352235
*/
22362236
async getDataFrameAnalyticsStats (this: That, params?: T.MlGetDataFrameAnalyticsStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlGetDataFrameAnalyticsStatsResponse>
@@ -2283,7 +2283,7 @@ export default class Ml {
22832283
}
22842284

22852285
/**
2286-
* Get datafeeds usage info. You can get statistics for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get statistics for all datafeeds by using `_all`, by specifying `*` as the `<feed_id>`, or by omitting the `<feed_id>`. If the datafeed is stopped, the only information you receive is the `datafeed_id` and the `state`. This API returns a maximum of 10,000 datafeeds.
2286+
* Get datafeed stats. You can get statistics for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get statistics for all datafeeds by using `_all`, by specifying `*` as the `<feed_id>`, or by omitting the `<feed_id>`. If the datafeed is stopped, the only information you receive is the `datafeed_id` and the `state`. This API returns a maximum of 10,000 datafeeds.
22872287
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-datafeed-stats | Elasticsearch API documentation}
22882288
*/
22892289
async getDatafeedStats (this: That, params?: T.MlGetDatafeedStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlGetDatafeedStatsResponse>
@@ -2499,7 +2499,7 @@ export default class Ml {
24992499
}
25002500

25012501
/**
2502-
* Get anomaly detection jobs usage info.
2502+
* Get anomaly detection job stats.
25032503
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-job-stats | Elasticsearch API documentation}
25042504
*/
25052505
async getJobStats (this: That, params?: T.MlGetJobStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlGetJobStatsResponse>

src/api/api/synonyms.ts

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,9 @@ export default class Synonyms {
4848
'rule_id'
4949
],
5050
body: [],
51-
query: []
51+
query: [
52+
'refresh'
53+
]
5254
},
5355
'synonyms.get_synonym': {
5456
path: [
@@ -83,7 +85,9 @@ export default class Synonyms {
8385
body: [
8486
'synonyms_set'
8587
],
86-
query: []
88+
query: [
89+
'refresh'
90+
]
8791
},
8892
'synonyms.put_synonym_rule': {
8993
path: [
@@ -93,7 +97,9 @@ export default class Synonyms {
9397
body: [
9498
'synonyms'
9599
],
96-
query: []
100+
query: [
101+
'refresh'
102+
]
97103
}
98104
}
99105
}

src/api/types.ts

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -34908,9 +34908,9 @@ export type SynonymsSynonymString = string
3490834908
export interface SynonymsSynonymsUpdateResult {
3490934909
/** The update operation result. */
3491034910
result: Result
34911-
/** Updating synonyms in a synonym set reloads the associated analyzers.
34911+
/** Updating synonyms in a synonym set can reload the associated analyzers in case refresh is set to true.
3491234912
* This information is the analyzers reloading result. */
34913-
reload_analyzers_details: IndicesReloadSearchAnalyzersReloadResult
34913+
reload_analyzers_details?: IndicesReloadSearchAnalyzersReloadResult
3491434914
}
3491534915

3491634916
export interface SynonymsDeleteSynonymRequest extends RequestBase {
@@ -34929,10 +34929,14 @@ export interface SynonymsDeleteSynonymRuleRequest extends RequestBase {
3492934929
set_id: Id
3493034930
/** The ID of the synonym rule to delete. */
3493134931
rule_id: Id
34932+
/** If `true`, the request will refresh the analyzers with the deleted synonym rule and wait for the new synonyms to be available before returning.
34933+
* If `false`, analyzers will not be reloaded with the deleted synonym rule
34934+
* @remarks This property is not supported on Elastic Cloud Serverless. */
34935+
refresh?: boolean
3493234936
/** All values in `body` will be added to the request body. */
34933-
body?: string | { [key: string]: any } & { set_id?: never, rule_id?: never }
34937+
body?: string | { [key: string]: any } & { set_id?: never, rule_id?: never, refresh?: never }
3493434938
/** All values in `querystring` will be added to the request querystring. */
34935-
querystring?: { [key: string]: any } & { set_id?: never, rule_id?: never }
34939+
querystring?: { [key: string]: any } & { set_id?: never, rule_id?: never, refresh?: never }
3493634940
}
3493734941

3493834942
export type SynonymsDeleteSynonymRuleResponse = SynonymsSynonymsUpdateResult
@@ -34998,30 +35002,41 @@ export interface SynonymsGetSynonymsSetsSynonymsSetItem {
3499835002
export interface SynonymsPutSynonymRequest extends RequestBase {
3499935003
/** The ID of the synonyms set to be created or updated. */
3500035004
id: Id
35005+
/** If `true`, the request will refresh the analyzers with the new synonyms set and wait for the new synonyms to be available before returning.
35006+
* If `false`, analyzers will not be reloaded with the new synonym set
35007+
* @remarks This property is not supported on Elastic Cloud Serverless. */
35008+
refresh?: boolean
3500135009
/** The synonym rules definitions for the synonyms set. */
3500235010
synonyms_set: SynonymsSynonymRule | SynonymsSynonymRule[]
3500335011
/** All values in `body` will be added to the request body. */
35004-
body?: string | { [key: string]: any } & { id?: never, synonyms_set?: never }
35012+
body?: string | { [key: string]: any } & { id?: never, refresh?: never, synonyms_set?: never }
3500535013
/** All values in `querystring` will be added to the request querystring. */
35006-
querystring?: { [key: string]: any } & { id?: never, synonyms_set?: never }
35014+
querystring?: { [key: string]: any } & { id?: never, refresh?: never, synonyms_set?: never }
3500735015
}
3500835016

3500935017
export interface SynonymsPutSynonymResponse {
35018+
/** The update operation result. */
3501035019
result: Result
35011-
reload_analyzers_details: IndicesReloadSearchAnalyzersReloadResult
35020+
/** Updating a synonyms set can reload the associated analyzers in case refresh is set to true.
35021+
* This information is the analyzers reloading result. */
35022+
reload_analyzers_details?: IndicesReloadSearchAnalyzersReloadResult
3501235023
}
3501335024

3501435025
export interface SynonymsPutSynonymRuleRequest extends RequestBase {
3501535026
/** The ID of the synonym set. */
3501635027
set_id: Id
3501735028
/** The ID of the synonym rule to be updated or created. */
3501835029
rule_id: Id
35030+
/** If `true`, the request will refresh the analyzers with the new synonym rule and wait for the new synonyms to be available before returning.
35031+
* If `false`, analyzers will not be reloaded with the new synonym rule
35032+
* @remarks This property is not supported on Elastic Cloud Serverless. */
35033+
refresh?: boolean
3501935034
/** The synonym rule information definition, which must be in Solr format. */
3502035035
synonyms: SynonymsSynonymString
3502135036
/** All values in `body` will be added to the request body. */
35022-
body?: string | { [key: string]: any } & { set_id?: never, rule_id?: never, synonyms?: never }
35037+
body?: string | { [key: string]: any } & { set_id?: never, rule_id?: never, refresh?: never, synonyms?: never }
3502335038
/** All values in `querystring` will be added to the request querystring. */
35024-
querystring?: { [key: string]: any } & { set_id?: never, rule_id?: never, synonyms?: never }
35039+
querystring?: { [key: string]: any } & { set_id?: never, rule_id?: never, refresh?: never, synonyms?: never }
3502535040
}
3502635041

3502735042
export type SynonymsPutSynonymRuleResponse = SynonymsSynonymsUpdateResult

0 commit comments

Comments
 (0)