Skip to content

Commit ed8cc23

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

17 files changed

+1197
-473
lines changed

src/ApiGenerator/opensearch-openapi.yaml

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

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

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ public partial class ClusterAllocationExplainDescriptor
7474
public ClusterAllocationExplainDescriptor IncludeDiskInfo(bool? includediskinfo = true) =>
7575
Qs("include_disk_info", includediskinfo);
7676

77-
/// <summary>When `true`, returns any `YES` decisions in the allocation explanation.</summary>
77+
/// <summary>When `true`, returns any `YES` decisions in the allocation explanation. `YES` decisions indicate when a particular shard allocation attempt was successful for the given node.</summary>
7878
public ClusterAllocationExplainDescriptor IncludeYesDecisions(
7979
bool? includeyesdecisions = true
8080
) => Qs("include_yes_decisions", includeyesdecisions);
@@ -105,7 +105,7 @@ protected DeleteComponentTemplateDescriptor()
105105
Name IDeleteComponentTemplateRequest.Name => Self.RouteValues.Get<Name>("name");
106106

107107
// Request parameters
108-
/// <summary>Operation timeout for connection to cluster-manager node.</summary>
108+
/// <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>
109109
/// <remarks>Supported by OpenSearch servers of version 2.0.0 or greater.</remarks>
110110
public DeleteComponentTemplateDescriptor ClusterManagerTimeout(
111111
Time clustermanagertimeout
@@ -165,7 +165,7 @@ protected ComponentTemplateExistsDescriptor()
165165
Name IComponentTemplateExistsRequest.Name => Self.RouteValues.Get<Name>("name");
166166

167167
// Request parameters
168-
/// <summary>A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.</summary>
168+
/// <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>
169169
/// <remarks>Supported by OpenSearch servers of version 2.0.0 or greater.</remarks>
170170
public ComponentTemplateExistsDescriptor ClusterManagerTimeout(
171171
Time clustermanagertimeout
@@ -210,12 +210,12 @@ public GetComponentTemplateDescriptor Name(Name name) =>
210210
Assign(name, (a, v) => a.RouteValues.Optional("name", v));
211211

212212
// Request parameters
213-
/// <summary>A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.</summary>
213+
/// <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>
214214
/// <remarks>Supported by OpenSearch servers of version 2.0.0 or greater.</remarks>
215215
public GetComponentTemplateDescriptor ClusterManagerTimeout(Time clustermanagertimeout) =>
216216
Qs("cluster_manager_timeout", clustermanagertimeout);
217217

218-
/// <summary>If `true`, returns settings in flat format.</summary>
218+
/// <summary>Whether to return settings in the flat form, which can improve readability, especially for heavily nested settings. For example, the flat form of `"cluster": { "max_shards_per_node": 500 }` is `"cluster.max_shards_per_node": "500"`.</summary>
219219
public GetComponentTemplateDescriptor FlatSettings(bool? flatsettings = true) =>
220220
Qs("flat_settings", flatsettings);
221221

@@ -243,7 +243,7 @@ public partial class ClusterGetSettingsDescriptor
243243

244244
// values part of the url path
245245
// Request parameters
246-
/// <summary>A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.</summary>
246+
/// <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>
247247
/// <remarks>Supported by OpenSearch servers of version 2.0.0 or greater.</remarks>
248248
public ClusterGetSettingsDescriptor ClusterManagerTimeout(Time clustermanagertimeout) =>
249249
Qs("cluster_manager_timeout", clustermanagertimeout);
@@ -307,7 +307,7 @@ public ClusterHealthDescriptor Index<TOther>()
307307
public ClusterHealthDescriptor AwarenessAttribute(string awarenessattribute) =>
308308
Qs("awareness_attribute", awarenessattribute);
309309

310-
/// <summary>A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.</summary>
310+
/// <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>
311311
/// <remarks>Supported by OpenSearch servers of version 2.0.0 or greater.</remarks>
312312
public ClusterHealthDescriptor ClusterManagerTimeout(Time clustermanagertimeout) =>
313313
Qs("cluster_manager_timeout", clustermanagertimeout);
@@ -329,7 +329,7 @@ public ClusterHealthDescriptor ExpandWildcards(ExpandWildcards? expandwildcards)
329329
public ClusterHealthDescriptor MasterTimeout(Time mastertimeout) =>
330330
Qs("master_timeout", mastertimeout);
331331

332-
/// <summary>A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.</summary>
332+
/// <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>
333333
public ClusterHealthDescriptor Timeout(Time timeout) => Qs("timeout", timeout);
334334

335335
/// <summary>Waits until the specified number of shards is active before returning a response. Use `all` for all shards.</summary>
@@ -372,7 +372,7 @@ public partial class ClusterPendingTasksDescriptor
372372

373373
// values part of the url path
374374
// Request parameters
375-
/// <summary>A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.</summary>
375+
/// <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>
376376
/// <remarks>Supported by OpenSearch servers of version 2.0.0 or greater.</remarks>
377377
public ClusterPendingTasksDescriptor ClusterManagerTimeout(Time clustermanagertimeout) =>
378378
Qs("cluster_manager_timeout", clustermanagertimeout);
@@ -438,7 +438,7 @@ protected PutComponentTemplateDescriptor()
438438
Name IPutComponentTemplateRequest.Name => Self.RouteValues.Get<Name>("name");
439439

440440
// Request parameters
441-
/// <summary>A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.</summary>
441+
/// <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>
442442
/// <remarks>Supported by OpenSearch servers of version 2.0.0 or greater.</remarks>
443443
public PutComponentTemplateDescriptor ClusterManagerTimeout(Time clustermanagertimeout) =>
444444
Qs("cluster_manager_timeout", clustermanagertimeout);
@@ -470,7 +470,7 @@ public partial class ClusterPutSettingsDescriptor
470470

471471
// values part of the url path
472472
// Request parameters
473-
/// <summary>A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.</summary>
473+
/// <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>
474474
/// <remarks>Supported by OpenSearch servers of version 2.0.0 or greater.</remarks>
475475
public ClusterPutSettingsDescriptor ClusterManagerTimeout(Time clustermanagertimeout) =>
476476
Qs("cluster_manager_timeout", clustermanagertimeout);
@@ -517,15 +517,15 @@ public partial class ClusterRerouteDescriptor
517517

518518
// values part of the url path
519519
// Request parameters
520-
/// <summary>A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.</summary>
520+
/// <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>
521521
/// <remarks>Supported by OpenSearch servers of version 2.0.0 or greater.</remarks>
522522
public ClusterRerouteDescriptor ClusterManagerTimeout(Time clustermanagertimeout) =>
523523
Qs("cluster_manager_timeout", clustermanagertimeout);
524524

525525
/// <summary>When `true`, the request simulates the operation and returns the resulting state.</summary>
526526
public ClusterRerouteDescriptor DryRun(bool? dryrun = true) => Qs("dry_run", dryrun);
527527

528-
/// <summary>When `true`, the response contains an explanation of why certain commands can or cannot be executed.</summary>
528+
/// <summary>When `true`, the response contains an explanation of why reroute certain commands can or cannot be executed.</summary>
529529
public ClusterRerouteDescriptor Explain(bool? explain = true) => Qs("explain", explain);
530530

531531
/// <summary>A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.</summary>
@@ -598,7 +598,7 @@ public ClusterStateDescriptor Metric(Metrics metric) =>
598598
public ClusterStateDescriptor AllowNoIndices(bool? allownoindices = true) =>
599599
Qs("allow_no_indices", allownoindices);
600600

601-
/// <summary>A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.</summary>
601+
/// <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>
602602
/// <remarks>Supported by OpenSearch servers of version 2.0.0 or greater.</remarks>
603603
public ClusterStateDescriptor ClusterManagerTimeout(Time clustermanagertimeout) =>
604604
Qs("cluster_manager_timeout", clustermanagertimeout);

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

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -80,22 +80,22 @@ public CancelTasksDescriptor(TaskId taskId)
8080
// values part of the url path
8181
TaskId ICancelTasksRequest.TaskId => Self.RouteValues.Get<TaskId>("task_id");
8282

83-
/// <summary>ID of the task.</summary>
83+
/// <summary>The ID of the task.</summary>
8484
public CancelTasksDescriptor TaskId(TaskId taskId) =>
8585
Assign(taskId, (a, v) => a.RouteValues.Optional("task_id", v));
8686

8787
// Request parameters
88-
/// <summary>Comma-separated list or wildcard expression of actions used to limit the request.</summary>
88+
/// <summary>A comma-separated list of actions that should be returned. Keep empty to return all.</summary>
8989
public CancelTasksDescriptor Actions(params string[] actions) => Qs("actions", actions);
9090

91-
/// <summary>Comma-separated list of node IDs or names used to limit the request.</summary>
91+
/// <summary>A comma-separated list of node IDs or names to limit the returned information. Use `_local` to return information from the node you're connecting to, specify the node name to get information from specific nodes, or keep the parameter empty to get information from all nodes.</summary>
9292
public CancelTasksDescriptor Nodes(params string[] nodes) => Qs("nodes", nodes);
9393

94-
/// <summary>Parent task ID used to limit the tasks.</summary>
94+
/// <summary>Returns tasks with a specified parent task ID (node_id:task_number). Keep empty or set to -1 to return all.</summary>
9595
public CancelTasksDescriptor ParentTaskId(string parenttaskid) =>
9696
Qs("parent_task_id", parenttaskid);
9797

98-
/// <summary>Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false.</summary>
98+
/// <summary>Waits for the matching task to complete. When `true`, the request is blocked until the task has completed.</summary>
9999
public CancelTasksDescriptor WaitForCompletion(bool? waitforcompletion = true) =>
100100
Qs("wait_for_completion", waitforcompletion);
101101
}
@@ -121,10 +121,10 @@ protected GetTaskDescriptor()
121121
TaskId IGetTaskRequest.TaskId => Self.RouteValues.Get<TaskId>("task_id");
122122

123123
// Request parameters
124-
/// <summary>Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.</summary>
124+
/// <summary>The amount of time to wait for a response.</summary>
125125
public GetTaskDescriptor Timeout(Time timeout) => Qs("timeout", timeout);
126126

127-
/// <summary>If `true`, the request blocks until the task has completed.</summary>
127+
/// <summary>Waits for the matching task to complete. When `true`, the request is blocked until the task has completed.</summary>
128128
public GetTaskDescriptor WaitForCompletion(bool? waitforcompletion = true) =>
129129
Qs("wait_for_completion", waitforcompletion);
130130
}
@@ -138,26 +138,26 @@ public partial class ListTasksDescriptor
138138

139139
// values part of the url path
140140
// Request parameters
141-
/// <summary>Comma-separated list or wildcard expression of actions used to limit the request.</summary>
141+
/// <summary>A comma-separated list of actions that should be returned. Keep empty to return all.</summary>
142142
public ListTasksDescriptor Actions(params string[] actions) => Qs("actions", actions);
143143

144-
/// <summary>If `true`, the response includes detailed information about shard recoveries.</summary>
144+
/// <summary>When `true`, the response includes detailed information about shard recoveries.</summary>
145145
public ListTasksDescriptor Detailed(bool? detailed = true) => Qs("detailed", detailed);
146146

147-
/// <summary>Key used to group tasks in the response.</summary>
147+
/// <summary>Groups tasks by parent/child relationships or nodes.</summary>
148148
public ListTasksDescriptor GroupBy(TasksGroupBy? groupby) => Qs("group_by", groupby);
149149

150-
/// <summary>Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.</summary>
150+
/// <summary>A comma-separated list of node IDs or names to limit the returned information. Use `_local` to return information from the node you're connecting to, specify the node name to get information from specific nodes, or keep the parameter empty to get information from all nodes.</summary>
151151
public ListTasksDescriptor Nodes(params string[] nodes) => Qs("nodes", nodes);
152152

153-
/// <summary>Parent task ID used to limit returned information. To return all tasks, omit this parameter or use a value of `-1`.</summary>
153+
/// <summary>Returns tasks with a specified parent task ID (node_id:task_number). Keep empty or set to -1 to return all.</summary>
154154
public ListTasksDescriptor ParentTaskId(string parenttaskid) =>
155155
Qs("parent_task_id", parenttaskid);
156156

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

160-
/// <summary>If `true`, the request blocks until the operation is complete.</summary>
160+
/// <summary>Waits for the matching task to complete. When `true`, the request is blocked until the task has completed.</summary>
161161
public ListTasksDescriptor WaitForCompletion(bool? waitforcompletion = true) =>
162162
Qs("wait_for_completion", waitforcompletion);
163163
}

0 commit comments

Comments
 (0)