Skip to content

Commit 75b47ca

Browse files
Xtansiagithub-actions[bot]
authored andcommitted
Re-generate client code using latest OpenSearch API specification (2025-03-24)
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent e8f20d3 commit 75b47ca

25 files changed

+1740
-798
lines changed

src/ApiGenerator/opensearch-openapi.yaml

Lines changed: 1040 additions & 432 deletions
Large diffs are not rendered by default.

src/OpenSearch.Client/_Generated/Descriptors.Cluster.cs

Lines changed: 22 additions & 22 deletions
Large diffs are not rendered by default.

src/OpenSearch.Client/_Generated/Descriptors.Ingest.cs

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ protected DeletePipelineDescriptor()
8282
Id IDeletePipelineRequest.Id => Self.RouteValues.Get<Id>("id");
8383

8484
// Request parameters
85-
/// <summary>Operation timeout for connection to cluster-manager node.</summary>
85+
/// <summary>The amount of time allowed to establish a connection to the cluster manager node.</summary>
8686
/// <remarks>Supported by OpenSearch servers of version 2.0.0 or greater.</remarks>
8787
public DeletePipelineDescriptor ClusterManagerTimeout(Time clustermanagertimeout) =>
8888
Qs("cluster_manager_timeout", clustermanagertimeout);
@@ -94,7 +94,7 @@ public DeletePipelineDescriptor ClusterManagerTimeout(Time clustermanagertimeout
9494
public DeletePipelineDescriptor MasterTimeout(Time mastertimeout) =>
9595
Qs("master_timeout", mastertimeout);
9696

97-
/// <summary>Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.</summary>
97+
/// <summary>The amount of time to wait for a response.</summary>
9898
public DeletePipelineDescriptor Timeout(Time timeout) => Qs("timeout", timeout);
9999
}
100100

@@ -121,12 +121,12 @@ public GetPipelineDescriptor(Id id)
121121
// values part of the url path
122122
Id IGetPipelineRequest.Id => Self.RouteValues.Get<Id>("id");
123123

124-
/// <summary>Comma-separated list of pipeline IDs to retrieve. Wildcard (`*`) expressions are supported. To get all ingest pipelines, omit this parameter or use `*`.</summary>
124+
/// <summary>A comma-separated list of pipeline IDs to retrieve. Wildcard (`*`) expressions are supported. To get all ingest pipelines, omit this parameter or use `*`.</summary>
125125
public GetPipelineDescriptor Id(Id id) =>
126126
Assign(id, (a, v) => a.RouteValues.Optional("id", v));
127127

128128
// Request parameters
129-
/// <summary>Operation timeout for connection to cluster-manager node.</summary>
129+
/// <summary>The amount of time allowed to establish a connection to the cluster manager node.</summary>
130130
/// <remarks>Supported by OpenSearch servers of version 2.0.0 or greater.</remarks>
131131
public GetPipelineDescriptor ClusterManagerTimeout(Time clustermanagertimeout) =>
132132
Qs("cluster_manager_timeout", clustermanagertimeout);
@@ -152,7 +152,7 @@ public partial class GrokProcessorPatternsDescriptor
152152

153153
// values part of the url path
154154
// Request parameters
155-
/// <summary>Sort returned patterns by key name.</summary>
155+
/// <summary>Determines how to sort returned grok patterns by key name.</summary>
156156
public GrokProcessorPatternsDescriptor SortByColumns(bool? sortbycolumns = true) =>
157157
Qs("s", sortbycolumns);
158158
}
@@ -182,7 +182,7 @@ protected PutPipelineDescriptor()
182182
Id IPutPipelineRequest.Id => Self.RouteValues.Get<Id>("id");
183183

184184
// Request parameters
185-
/// <summary>Operation timeout for connection to cluster-manager node.</summary>
185+
/// <summary>The amount of time allowed to establish a connection to the cluster manager node.</summary>
186186
/// <remarks>Supported by OpenSearch servers of version 2.0.0 or greater.</remarks>
187187
public PutPipelineDescriptor ClusterManagerTimeout(Time clustermanagertimeout) =>
188188
Qs("cluster_manager_timeout", clustermanagertimeout);
@@ -194,7 +194,7 @@ public PutPipelineDescriptor ClusterManagerTimeout(Time clustermanagertimeout) =
194194
public PutPipelineDescriptor MasterTimeout(Time mastertimeout) =>
195195
Qs("master_timeout", mastertimeout);
196196

197-
/// <summary>Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.</summary>
197+
/// <summary>The amount of time to wait for a response.</summary>
198198
public PutPipelineDescriptor Timeout(Time timeout) => Qs("timeout", timeout);
199199
}
200200

@@ -221,12 +221,12 @@ public SimulatePipelineDescriptor(Id id)
221221
// values part of the url path
222222
Id ISimulatePipelineRequest.Id => Self.RouteValues.Get<Id>("id");
223223

224-
/// <summary>Pipeline to test. If you don't specify a `pipeline` in the request body, this parameter is required.</summary>
224+
/// <summary>The pipeline to test. If you don't specify a `pipeline` in the request body, this parameter is required.</summary>
225225
public SimulatePipelineDescriptor Id(Id id) =>
226226
Assign(id, (a, v) => a.RouteValues.Optional("id", v));
227227

228228
// Request parameters
229-
/// <summary>If `true`, the response includes output data for each processor in the executed pipeline.</summary>
229+
/// <summary>When `true`, the response includes output data for each processor in the pipeline.</summary>
230230
public SimulatePipelineDescriptor Verbose(bool? verbose = true) => Qs("verbose", verbose);
231231
}
232232
}

src/OpenSearch.Client/_Generated/Descriptors.Snapshot.cs

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ protected CleanupRepositoryDescriptor()
8282
Name ICleanupRepositoryRequest.RepositoryName => Self.RouteValues.Get<Name>("repository");
8383

8484
// Request parameters
85-
/// <summary>Operation timeout for connection to cluster-manager node.</summary>
85+
/// <summary>The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters](https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units).</summary>
8686
/// <remarks>Supported by OpenSearch servers of version 2.0.0 or greater.</remarks>
8787
public CleanupRepositoryDescriptor ClusterManagerTimeout(Time clustermanagertimeout) =>
8888
Qs("cluster_manager_timeout", clustermanagertimeout);
@@ -94,7 +94,7 @@ public CleanupRepositoryDescriptor ClusterManagerTimeout(Time clustermanagertime
9494
public CleanupRepositoryDescriptor MasterTimeout(Time mastertimeout) =>
9595
Qs("master_timeout", mastertimeout);
9696

97-
/// <summary>Period to wait for a response.</summary>
97+
/// <summary>The amount of time to wait for a response.</summary>
9898
public CleanupRepositoryDescriptor Timeout(Time timeout) => Qs("timeout", timeout);
9999
}
100100

@@ -131,7 +131,7 @@ protected CloneSnapshotDescriptor()
131131
Name ICloneSnapshotRequest.TargetSnapshot => Self.RouteValues.Get<Name>("target_snapshot");
132132

133133
// Request parameters
134-
/// <summary>Operation timeout for connection to cluster-manager node.</summary>
134+
/// <summary>The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters](https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units).</summary>
135135
/// <remarks>Supported by OpenSearch servers of version 2.0.0 or greater.</remarks>
136136
public CloneSnapshotDescriptor ClusterManagerTimeout(Time clustermanagertimeout) =>
137137
Qs("cluster_manager_timeout", clustermanagertimeout);
@@ -167,7 +167,7 @@ protected SnapshotDescriptor()
167167
Name ISnapshotRequest.Snapshot => Self.RouteValues.Get<Name>("snapshot");
168168

169169
// Request parameters
170-
/// <summary>Operation timeout for connection to cluster-manager node.</summary>
170+
/// <summary>The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters](https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units).</summary>
171171
/// <remarks>Supported by OpenSearch servers of version 2.0.0 or greater.</remarks>
172172
public SnapshotDescriptor ClusterManagerTimeout(Time clustermanagertimeout) =>
173173
Qs("cluster_manager_timeout", clustermanagertimeout);
@@ -179,7 +179,7 @@ public SnapshotDescriptor ClusterManagerTimeout(Time clustermanagertimeout) =>
179179
public SnapshotDescriptor MasterTimeout(Time mastertimeout) =>
180180
Qs("master_timeout", mastertimeout);
181181

182-
/// <summary>If `true`, the request returns a response when the snapshot is complete. If `false`, the request returns a response when the snapshot initializes.</summary>
182+
/// <summary>When `true`, the request returns a response when the snapshot is complete. When `false`, the request returns a response when the snapshot initializes.</summary>
183183
public SnapshotDescriptor WaitForCompletion(bool? waitforcompletion = true) =>
184184
Qs("wait_for_completion", waitforcompletion);
185185
}
@@ -209,7 +209,7 @@ protected CreateRepositoryDescriptor()
209209
Name ICreateRepositoryRequest.RepositoryName => Self.RouteValues.Get<Name>("repository");
210210

211211
// Request parameters
212-
/// <summary>Operation timeout for connection to cluster-manager node.</summary>
212+
/// <summary>The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters](https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units).</summary>
213213
/// <remarks>Supported by OpenSearch servers of version 2.0.0 or greater.</remarks>
214214
public CreateRepositoryDescriptor ClusterManagerTimeout(Time clustermanagertimeout) =>
215215
Qs("cluster_manager_timeout", clustermanagertimeout);
@@ -221,10 +221,10 @@ public CreateRepositoryDescriptor ClusterManagerTimeout(Time clustermanagertimeo
221221
public CreateRepositoryDescriptor MasterTimeout(Time mastertimeout) =>
222222
Qs("master_timeout", mastertimeout);
223223

224-
/// <summary>Explicit operation timeout.</summary>
224+
/// <summary>The amount of time to wait for a response.</summary>
225225
public CreateRepositoryDescriptor Timeout(Time timeout) => Qs("timeout", timeout);
226226

227-
/// <summary>Whether to verify the repository after creation.</summary>
227+
/// <summary>When `true`, verifies the creation of the snapshot repository.</summary>
228228
public CreateRepositoryDescriptor Verify(bool? verify = true) => Qs("verify", verify);
229229
}
230230

@@ -255,7 +255,7 @@ protected DeleteSnapshotDescriptor()
255255
Name IDeleteSnapshotRequest.Snapshot => Self.RouteValues.Get<Name>("snapshot");
256256

257257
// Request parameters
258-
/// <summary>Operation timeout for connection to cluster-manager node.</summary>
258+
/// <summary>The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters](https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units).</summary>
259259
/// <remarks>Supported by OpenSearch servers of version 2.0.0 or greater.</remarks>
260260
public DeleteSnapshotDescriptor ClusterManagerTimeout(Time clustermanagertimeout) =>
261261
Qs("cluster_manager_timeout", clustermanagertimeout);
@@ -293,7 +293,7 @@ protected DeleteRepositoryDescriptor()
293293
Names IDeleteRepositoryRequest.RepositoryName => Self.RouteValues.Get<Names>("repository");
294294

295295
// Request parameters
296-
/// <summary>Operation timeout for connection to cluster-manager node.</summary>
296+
/// <summary>The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters](https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units).</summary>
297297
/// <remarks>Supported by OpenSearch servers of version 2.0.0 or greater.</remarks>
298298
public DeleteRepositoryDescriptor ClusterManagerTimeout(Time clustermanagertimeout) =>
299299
Qs("cluster_manager_timeout", clustermanagertimeout);
@@ -305,7 +305,7 @@ public DeleteRepositoryDescriptor ClusterManagerTimeout(Time clustermanagertimeo
305305
public DeleteRepositoryDescriptor MasterTimeout(Time mastertimeout) =>
306306
Qs("master_timeout", mastertimeout);
307307

308-
/// <summary>Explicit operation timeout.</summary>
308+
/// <summary>The amount of time to wait for a response.</summary>
309309
public DeleteRepositoryDescriptor Timeout(Time timeout) => Qs("timeout", timeout);
310310
}
311311

@@ -336,12 +336,12 @@ protected GetSnapshotDescriptor()
336336
Names IGetSnapshotRequest.Snapshot => Self.RouteValues.Get<Names>("snapshot");
337337

338338
// Request parameters
339-
/// <summary>Operation timeout for connection to cluster-manager node.</summary>
339+
/// <summary>The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters](https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units).</summary>
340340
/// <remarks>Supported by OpenSearch servers of version 2.0.0 or greater.</remarks>
341341
public GetSnapshotDescriptor ClusterManagerTimeout(Time clustermanagertimeout) =>
342342
Qs("cluster_manager_timeout", clustermanagertimeout);
343343

344-
/// <summary>If `false`, the request returns an error for any snapshots that are unavailable.</summary>
344+
/// <summary>When `false`, the request returns an error for any snapshots that are unavailable.</summary>
345345
public GetSnapshotDescriptor IgnoreUnavailable(bool? ignoreunavailable = true) =>
346346
Qs("ignore_unavailable", ignoreunavailable);
347347

@@ -352,7 +352,7 @@ public GetSnapshotDescriptor IgnoreUnavailable(bool? ignoreunavailable = true) =
352352
public GetSnapshotDescriptor MasterTimeout(Time mastertimeout) =>
353353
Qs("master_timeout", mastertimeout);
354354

355-
/// <summary>If `true`, returns additional information about each snapshot such as the version of OpenSearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted.</summary>
355+
/// <summary>When `true`, returns additional information about each snapshot such as the version of OpenSearch which took the snapshot, the start and end times of the snapshot, and the number of shards contained in the snapshot.</summary>
356356
public GetSnapshotDescriptor Verbose(bool? verbose = true) => Qs("verbose", verbose);
357357
}
358358

@@ -384,12 +384,12 @@ public GetRepositoryDescriptor RepositoryName(Names repository) =>
384384
Assign(repository, (a, v) => a.RouteValues.Optional("repository", v));
385385

386386
// Request parameters
387-
/// <summary>Operation timeout for connection to cluster-manager node.</summary>
387+
/// <summary>The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters](https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units).</summary>
388388
/// <remarks>Supported by OpenSearch servers of version 2.0.0 or greater.</remarks>
389389
public GetRepositoryDescriptor ClusterManagerTimeout(Time clustermanagertimeout) =>
390390
Qs("cluster_manager_timeout", clustermanagertimeout);
391391

392-
/// <summary>Return local information, do not retrieve the state from cluster-manager node.</summary>
392+
/// <summary>Whether to get information from the local node.</summary>
393393
public GetRepositoryDescriptor Local(bool? local = true) => Qs("local", local);
394394

395395
/// <summary>Explicit operation timeout for connection to cluster-manager node.</summary>
@@ -423,7 +423,7 @@ protected RestoreDescriptor()
423423
Name IRestoreRequest.Snapshot => Self.RouteValues.Get<Name>("snapshot");
424424

425425
// Request parameters
426-
/// <summary>Operation timeout for connection to cluster-manager node.</summary>
426+
/// <summary>The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters](https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units).</summary>
427427
/// <remarks>Supported by OpenSearch servers of version 2.0.0 or greater.</remarks>
428428
public RestoreDescriptor ClusterManagerTimeout(Time clustermanagertimeout) =>
429429
Qs("cluster_manager_timeout", clustermanagertimeout);
@@ -435,7 +435,7 @@ public RestoreDescriptor ClusterManagerTimeout(Time clustermanagertimeout) =>
435435
public RestoreDescriptor MasterTimeout(Time mastertimeout) =>
436436
Qs("master_timeout", mastertimeout);
437437

438-
/// <summary>Should this request wait until the operation has completed before returning.</summary>
438+
/// <summary>-| Whether to return a response after the restore operation has completed. When `false`, the request returns a response when the restore operation initializes. When `true`, the request returns a response when the restore operation completes.</summary>
439439
public RestoreDescriptor WaitForCompletion(bool? waitforcompletion = true) =>
440440
Qs("wait_for_completion", waitforcompletion);
441441
}
@@ -470,7 +470,7 @@ public SnapshotStatusDescriptor(Name repository, Names snapshot)
470470
Name ISnapshotStatusRequest.RepositoryName => Self.RouteValues.Get<Name>("repository");
471471
Names ISnapshotStatusRequest.Snapshot => Self.RouteValues.Get<Names>("snapshot");
472472

473-
/// <summary>A repository name.</summary>
473+
/// <summary>The name of the repository containing the snapshot.</summary>
474474
public SnapshotStatusDescriptor RepositoryName(Name repository) =>
475475
Assign(repository, (a, v) => a.RouteValues.Optional("repository", v));
476476

@@ -479,12 +479,12 @@ public SnapshotStatusDescriptor Snapshot(Names snapshot) =>
479479
Assign(snapshot, (a, v) => a.RouteValues.Optional("snapshot", v));
480480

481481
// Request parameters
482-
/// <summary>Operation timeout for connection to cluster-manager node.</summary>
482+
/// <summary>The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters](https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units).</summary>
483483
/// <remarks>Supported by OpenSearch servers of version 2.0.0 or greater.</remarks>
484484
public SnapshotStatusDescriptor ClusterManagerTimeout(Time clustermanagertimeout) =>
485485
Qs("cluster_manager_timeout", clustermanagertimeout);
486486

487-
/// <summary>Whether to ignore unavailable snapshots, defaults to `false` which means a SnapshotMissingException is thrown.</summary>
487+
/// <summary>Whether to ignore any unavailable snapshots, When `false`, a `SnapshotMissingException` is thrown.</summary>
488488
public SnapshotStatusDescriptor IgnoreUnavailable(bool? ignoreunavailable = true) =>
489489
Qs("ignore_unavailable", ignoreunavailable);
490490

@@ -521,7 +521,7 @@ protected VerifyRepositoryDescriptor()
521521
Name IVerifyRepositoryRequest.RepositoryName => Self.RouteValues.Get<Name>("repository");
522522

523523
// Request parameters
524-
/// <summary>Operation timeout for connection to cluster-manager node.</summary>
524+
/// <summary>The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters](https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units).</summary>
525525
/// <remarks>Supported by OpenSearch servers of version 2.0.0 or greater.</remarks>
526526
public VerifyRepositoryDescriptor ClusterManagerTimeout(Time clustermanagertimeout) =>
527527
Qs("cluster_manager_timeout", clustermanagertimeout);
@@ -533,7 +533,7 @@ public VerifyRepositoryDescriptor ClusterManagerTimeout(Time clustermanagertimeo
533533
public VerifyRepositoryDescriptor MasterTimeout(Time mastertimeout) =>
534534
Qs("master_timeout", mastertimeout);
535535

536-
/// <summary>Explicit operation timeout.</summary>
536+
/// <summary>The amount of time to wait for a response.</summary>
537537
public VerifyRepositoryDescriptor Timeout(Time timeout) => Qs("timeout", timeout);
538538
}
539539
}

0 commit comments

Comments
 (0)